Step 1 - Load new Docker images

When you choose a new version, the shotgun-docker-se package will be extracted and all the necessary Docker images will be loaded in every node for that cluster.

sudo tar -xvzf shotgun-docker-se-x.x.x.x.tar.gz
sudo docker load < shotgun-app.x.x.x.x.tar

If the necessary images are already loaded, the package will simply proceed to the following step.

Step 2 - Pre-update

Some database operations might take a while to execute, so before going in maintenance mode, you can apply the changes below while your site is still running. The database modifications in this step are considered low risk and non-disruptive, mainly adding additional indexes.

 sudo docker-compose run --rm app rake admin:pre_upgrade

This is only executed once per cluster, not once per node. There is no downtime required during this operation.

Step 3 - Start maintenance

Flow Production Tracking SE Docker v7.3 and earlier

When you start the maintenance, all app and email notifier containers will stop for every node in that cluster.

 sudo docker-compose stop app emailnotifier

If you are using the proxy, you should see the maintenance page, which means that your site is now officially unavailable.

Flow Production Tracking SE Docker v7.4 and later and Flow Production Tracking

When you start the maintenance, all app containers will display the maintenance page and all email notifier containers will stop for every node in that cluster.

sudo docker-compose run --rm app sg_maintenance_page --enable duration “details”
sudo docker-compose stop emailnotifier

The duration (in minutes) and details will be displayed on the maintenance page.

Step 4 - Backup

This step is optional but it is always a good idea to do a cold backup of your database, while Flow Production Tracking is not being used, before updating to a newer version of Flow Production Tracking.

Step 5 - Update

When you update your Flow Production Tracking database, it will apply all the necessary database modifications that are required to run this specific version of Flow Production Tracking.

 sudo docker-compose run --rm app rake admin:upgrade

This is only executed once per cluster, not once per node.

Step 6 - Update docker-compose.yml

If you are using Docker Compose as an orchestration tool, you will need to update your docker-compose.yml file in every node for this cluster in order to be on par with the current update.

 version: '2'
  services:
    app:
      image: shotgun-app:x.x.x.x
      ...
    emailnotifier:
      image: shotgun-app:x.x.x.x
      ...

Step 7 - Stop maintenance

When you stop the maintenance, all app and email notifier containers will be recreated with the new version and started for every node in that cluster.

 sudo docker-compose up -d

If you are using the proxy, the maintenance page should disappear and you should be able to access your site again.