Flow Production Tracking official update path

As explained in details in the Procedure to update Flow Production Tracking, Flow Production Tracking needs to be upgraded by steps. Here is the current official update path for Flow Production Tracking:

v5.3.41 → v5.4.14 → v6.0.3 → v6.1.4_ldapfix → v6.2.7 → v6.3.18.0 → v7.x → v8.0.1.4 → [8.20.0.6829-v8.33.0.9543] → v8.x

Upgrading guide

Upgrading to 8.23.0.7554

The 8.23.0.7554 release include a cleanup of empty or retired draft notes that could take a long time during the upgrade process.

Empty draft notes

In order to minimize the impact on your production server, we recommend you run the following psql command on your production database to find how many entries need to be purged.

SELECT count(*)
FROM notes
WHERE
    ((draft = TRUE AND subject IS NULL AND content IS NULL) AND (
    (created_at < (CURRENT_DATE - (8 * INTERVAL '1 WEEK') ) AND
    (updated_at < (CURRENT_DATE - (8 * INTERVAL '1 WEEK') )) OR (updated_at IS NULL))));

You can estimate the migration time, migration will process around 1000 entries per minutes.

If the upgrade time is too high, execute the following command on your production instance in a ruby console before upgrading. This command may run for hours.

Start a Flow Production Tracking ruby console:

docker-compose run --rm app script/console

Paste the following commands:

Note.purge_empty_draft_notes(up_to_in_weeks: 8, dry_run: false)

Retired draft notes

We recommend you run the following psql command on your production database to find how many entries need to be purged.

SELECT count(*) FROM notes WHERE (draft = TRUE AND retirement_date < (CURRENT_DATE - (8 * INTERVAL '1 WEEK')));

You can estimate the migration time, migration will process around 1000 entries per minutes.

If the upgrade time is too high, execute the following command on your production instance in a ruby console before upgrading. This command may run for hours.

Start a Flow Production Tracking ruby console:

docker-compose run --rm app script/console

Paste the following commands:

up_to_in_weeks = 8
purge_retired_criteria = <<~SQL
draft = TRUE AND retirement_date < (CURRENT_DATE - ($1 * INTERVAL '1 WEEK'))
SQL
# Retired draft notes (cleared or published)
criteria = [purge_retired_criteria, [up_to_in_weeks]]
Shotgun::Retirement.destroy_entities(Note, criteria, dry_run: false)

Upgrading to 8.16.0.5484

• Updating to this version may result in significant downtime. See Flow Production Tracking Enterprise 8.16.0.5484 Release Notes for more details.

Upgrading to 8.11.0.4211

• Flow Production Tracking Enterprise Console 2.1.5 is required for this upgrade.

Upgrading to 8.7.0.2979

• MEMCACHED_EXTRA_KEY_PREFIX env variable has been introduced. See Application container customization for more information.

Upgrading to 8.3.2.2

• SHOTGUN_USER_GID env variable has been introduced. See Application container customization for more information.

Upgrading to 8.1.2.3

• Flow Production Tracking must be upgraded to 8.0.1.4 first.
• See Docker SE 8.1.2.3 release notes.

Upgrading to 7.11.2.2

• PostgreSQL 9.6 and above is now required. 

Upgrading to 7.10.2.3

• The ability of API script keys to querying other API script keys have been removed. See Flow Production Tracking Enterprise 7.10.2.2 Release Notes for more details.

Upgrading to 7.7.2.2

• MAX_PASSENGER_PROCESSES has been renamed PASSENGER_PROCESSES. shotgun-app container no longer scale up and down the number of processes, it's always running the number specified by PASSENGER_PROCESSES.  This improve the handling of request spike.
• Docker SEC version 2.1.2 or above is recommended to install Shotgun 7.6 and up.
• The 7.7.2.2 release includes a migration that finds and removes orphaned PageSettings. For some clients with larger numbers of pages (and resultant PageSettings), the query in the migration could be quite slow and cause the migration to take longer than might be expected. A workaround is available to speed things up. This issue is fixed in 7.10.1.0.

Upgrading to 7.5.2.0

• If a file like net_ldap.yml was mounted in the shotgun-app container, please modify the mount point to /var/rails/shotgun/current.

Upgrading to 7.4.3.0

• CUSTOM_CODE env variable has been renamed SHOTGUN_CUSTOM_CODE.

Upgrading to 7.2.3.0

• If you have migrated from SE Classic to SE Docker prior to July 2018, you may be affected by an issue with the functions ownership in the database. See this article for more details.
• Updating to this version may result in significant downtime. See Flow Production Tracking Enterprise 7.2.3.0 Release Notes for more details.