Quality Modeller Core Linux Update

1 - Backup All Data Stores

See our page on Test Modeller Maintenance to make sure that the postgres and neo4j databases are backed and stored securely. 

Optionally, you may want to back up the docker images as well, in case you need to roll back the update.

2 - Backup Old Files

If the previous installation was uzipped in a folder that contains the version name, for example:

/opt/curiosity/1.16.2

Then you already have a backup of config. If you did not use the version, then you should back up the files in the package folder.

3 - Copy New Version Onto Linux Filesystem

Unzip the latest version of Test Modeller into /opt/curiosity/[version number].

unzip dockerDeployment_1.17.0 -d /opt/curiosity/1.17.0

4 - Copy Configuration

Usually it should be enough to simply copy over the .env file and the docker-compose-custom.yml file (if it exists) over from the previous install. If you have a new license, this is the time to put it into the .env file. 

Some custom installs may have involved changes to other files such as nginx config. 

Make sure that any config files are copied over to the new application folder. 

5 - Changes in The Docker-Compose File

Normally there are no changes in the docker compose file. If there are, there will be special instructions for that version upgrade.

6 - Clean Out Current Images

Run the following to clear the current images from the local registry

sudo ./reset-environment.sh

7 - Start The New Version

The exact command will depend on what was used during the initial installation. In most cases it will be:

sudo ./run.sh

If you get the error "ERROR: The Compose file './docker-compose -f docker-compose-fullstack.yml up' Unsupported config option for services.modeller_job_engine: 'init'. Then you need to remove the 'init' line from the docker file in the 'job_engine' section.

8 - Legacy Update Method (Optional)

The steps detailed above describe the process for updating Test Modeller from version 2.25.0 and above. If you have an older version of Test Modeller and are updating to 2.25.0 or above, the Curiosity team will usually help with migrating to this new process. However, if for some reason the old method of updating the docker-compose-fullstack-*.yml files is required, the Test Modeller package folder will have a legacy subfolder which contains the old docker-compose-fullstack-*.yml files and the old version of the run.sh script. You can edit those files and start the services by first navigating to this legacy subfolder:

cd legacy
sudo ./run.sh