Sitegeist.ScentMark

Mark and Sniff on Neos via CLI. This can help to optimize cache flushing in Cluster Environments with a green / blue caching or publishing setup wehere certain tasks like cache flushing or publishing of static resources shall only be excuted on the first container of an newly deployed app version.

Usage

The package contains two cli commands:

• ./flow scentmark:mark __mark__ Store the given scent in the ScentCache

• ./flow scentmark:sniff __mark__ Compare the cached scent with the stored value and return an error code if both do not match.

Example

1. Configure ScentCache to be shared across containers.

Caches.yaml

Sitegeist_ScentMark_ScentCache:
  backend: 'Neos\Cache\Backend\RedisBackend'

2. Adjust the container spinup script

start.sh:

./flow scentmark:sniff $APP_VERSION
RESULT=$?
if [ $RESULT -ne 0 ]; then
    ./flow scentmark:mark $APP_VERSION
    ./flow flow:cache:flush 
    ./flow resource:publish --collection static
fi

3. Configure flow to switch with every cache between Green / Blue caching environment
4. Ensure the current APP_VERSION is available in the containers

Authors & Sponsors

• Martin Ficzel - ficzel@sitegeist.de

The development and the public-releases of this package is generously sponsored by our employer http://www.sitegeist.de.

Installation

Sitegeist.ScentMark is available via packagist. Run composer require sitegeist/scentmark to require this package.

We use semantic-versioning so every breaking change will increase the major-version number.

Contribution

We will gladly accept contributions. Please send us pull requests.