Updating Tonic
Tonic allows Admin users of self-hosted Kubernetes and Docker deployments to update to the newest version of Tonic.
Before you update Tonic, we suggest that you do the following:
- Have a system to regularly back up your Tonic PostgreSQL application database.
- Verify that the Kubernetes environment has access to quay.io. If you run Tonic in an air-gapped environment, or if you re-hosted the images from quay.io, make sure that values.yaml reflects this change, and that you have updated your local repository with the latest version from quay.io. To view the current latest release version, see Release notes.
- Update your helm charts to use the
latesttag. If you manage your helm charts in a repository that has a pinned version tag, then when you redeploy from your helm charts, Tonic reverts to the pinned version tag.
Before you update Tonic, we suggest that you do the following:
- Have a system to regularly back up your Tonic PostgreSQL application database.
- Verify that the Docker environment has access to quay.io. If you run Tonic in an air-gapped environment, or if you re-hosted the images from quay.io, make sure that docker-compose.yaml reflects this change, and that you have updated your local repository with the latest version from quay.io. To view the current latest release version, see Release notes.
- Update your docker-compose.yaml file to use the
latesttag. - In docker-compose.yaml, uncomment the
tonic_docker_aclsection. In the sample docker-compose.yaml, the section is underSTART ONE-CLICK UPDATE. - In your environment file, under
START ONE-CLICK UPDATE, uncomment and provide values for the following properties:DOCKER_REPO_USERNAMEDOCKER_REPO_PASSWORD
For information on how to populate those values, see the One-Click Update and Host Integration section of the readme. Make sure that thetonic_docker_aclsection of docker-compose.yaml includes references to the values that you set in the environment file.
Before it can enable the update option, Tonic must be able to retrieve information about the latest Tonic version.
To support this, you must allowlist the following URLs:
- https://temp-tonic-release.s3.amazonaws.com/version.txt
- https://temp-tonic-release.s3.amazonaws.com/?prefix=version.txt
Before you launch an update:
- Verify that there is enough system space for a second instance of the Tonic application. While the new instance starts, the original instance is still live. Once the new instance is running, the original is removed and the resources are freed up.
The option to update Tonic is on the System Status tab of the Admin Panel. Admin Panel is only available to admin users.
To display the Admin Panel, in the Tonic heading, click Admin.
On the System Status tab, if you can update Tonic, a blue Update to Tonic <version> button displays. The button is only available if Tonic is not on the most recent version.
You cannot start the update if Tonic jobs are running or are queued to run.
After you start the update, do not start other jobs until the update is complete.
You are given an estimated down time when you start the update, but the update typically takes less than ten minutes.
Any jobs that start during update process are silently terminated. This could leave your destination database in an unexpected state. If this happens, rerun the jobs.