🔁Upgrades and rollbacks

This document will guide you through the recommended process and best practices for upgrading a Helm release in a Kubernetes cluster to minimize the risk of service disruption or deployment failure.

Reviewing the changelog and breaking changes

Review the changelog before deploying a new release. It is accessible at this page: Self-Hosted Toucan - Changelog.

If you notice any breaking changes, read this document: Self-Hosted Toucan - Upgrading.

In Helm, there is two types of versions: the chart version and the app version. The chart version is the version of the chart itself, while the app version is the version of the application deployed by the chart.

Our release process dictates these rules:

• A major version is released when the configuration is breaking upon upgrade.

• A minor version is released when a new feature is added, or a dependency is updated by major or minor.

• A patch version is released when a fix is developped, or a dependency is updated by patch.

We will always assure that these rules are followed.

Procedure

1. (optional) For safety, you can check the difference in Kubernetes resources before upgrading the release.

   shell

   helm diff upgrade toucan-stack --version <version> oci://quay.io/toucantoco/charts/toucan-stack -f ./values.override.yaml

2. Upgrade the release.

shell

helm upgrade --install toucan-stack oci://quay.io/toucantoco/charts/toucan-stack \
  --namespace toucan \
  --values ./values.override.yaml

1. (optional) Check the logs of the deployment to ensure the upgrade was successful.

Failed to upgrade the release?

Run:

shell

helm rollback toucan-stack

Getting notified

It's up to you to use you own solution to get notified for updates. However, if you're getting started, we can recommend you into using Renovate to track updates.

It is self-hostable, or can run as Github App, and will notify about any updates to the chart by creating a PR in your repository.

You can configure Renovate using a configuration file at the root of your repository, but, normally, Renovate will create a PR to also create a configuration for you.

Usually, Renovate automatically detects the Helm charts.