TOИIC
Search…
Updating Tonic
Tonic allows Admin Users of self-hosted Kubernetes and Docker deployments to update to the newest version of Tonic.

Kubernetes setup

Before using this feature, we suggest you set up the following:
  • Have a system of regularly backing up your Tonic Postgres application database.
  • Source the latest version of Tonic from Quay as indicated in the sample yaml file and as instructed here.
    • If you are re-hosting Tonic’s images from quay.io to your own image repository by modifying the helm charts, you must ensure the latest Tonic version images have been loaded into your repository before running the in application update. Please see our release notes to find the current latest release version.
  • Update your helm charts to use the latest tag. If you are managing your helm charts in a repository with a pinned version tag, redeploying from your helm charts will revert Tonic to the pinned version tag.
  • Ensure your values.yaml file contains the following values (the examples below can be found in the sample yaml file as well) :
    • tonicai.web_server.features.host_integration_enabled: "true"
    • tonicai.web_server.features.kubernetes_role: "default"
    • tonicai.web_server.administrators: [admin_email]@company.com

Docker setup

Before using this feature, we suggest you set up the following:
  • Have a system of regularly backing up your Tonic Postgres application database
  • Source the latest version of Tonic from Quay as indicated in the sample Docker Compose repo and as instructed here.
    • If you are re-hosting Tonic’s images from quay.io to your own image repository by modifying the helm charts, you must ensure the latest Tonic version images have been loaded into your repository before running the in application update. Please see our release notes to find the current latest release version.
  • Update your docker-compose.yaml to use the latest tag.
  • Uncomment the tonic_docker_acl section of docker-compose.yaml
  • Uncomment the one-click update section of your environment file. Fill in the DOCKER_REPO_USERNAME and DOCKER_REPO_PASSWORD.
  • Read through the One-Click Update section of the readme.

Process

Before launching an update:
  • Verify there is enough system space for a second instance of the Tonic app. While the new instance is starting, the original instance is still live. Once the new instance is running, the original will be removed and the resources will be freed up.
  • Check the release notes for any updates that may impact your configuration.
To launch an update:
  1. 1.
    Navigate to the Admin Panel (this will only appear for Admin Users)
  2. 2.
    Scroll to the bottom and select the blue "Update to Tonic" button as shown in the screenshot below. The button will only be available if Tonic is deployed via Kubernetes and is not on the most recent version.
Tonic will not allow you to perform the update until no Tonic jobs are running or are queued to run.
Once the update has started, do not start other jobs until the update is complete. You will be given an estimated down time once you have started the update, but this will typically take less than ten minutes. Any jobs that start while the update process is running will be silently terminated and could leave your destination database in an unexpected state. If this happens, you will need to rerun the jobs.