Upgrading to 0.17.x

This guide explains how to upgrade from 0.16.x to 0.17.x.

Caution

A Kannika Armory version sometimes contain changes that prepare existing resources for an upcoming release, such as new annotations and labels.

Make sure you always upgrade in steps and never skip a version.

Before you begin

Before you begin the upgrade process, ensure that you have a backup of your data.

The upgrade process will not touch the actual backup data, but might change the resource definitions.

Breaking changes

This release contains no breaking changes. All new configuration is additive and existing resources continue to work unchanged.

Checklist

Follow the steps in this checklist to upgrade to 0.17.x.

• Enable maintenance mode
• Upgrade CRDs
• Install application with updated Helm values
• Disable maintenance mode
• Verify the installation

Enable maintenance mode

Enable maintenance mode for the duration of the upgrade.

values.yaml

global:
  maintenance:
    enabled: true
    banner:
      message: "Upgrade in progress, we will be back shortly."
      variant: "info"

Upgrade CRDs

Install the new Custom Resource Definitions (CRDs) for 0.17.x.:

Using kubectl

$ kubectl apply -f https://docs.kannika.io/refs/0.17.0/crd/kannika-crd-v1alpha.yml

Using Helm

$ helm install kannika-crd oci://quay.io/kannika/charts/kannika-crd \
  --version 0.17.0

Install application with updated Helm values

Pod reaper

This release adds new optional Helm values for the pod reaper. They are enabled by default, so no action is required unless you want to change the timeout or interval, or turn the reaper off.

values.yaml

operator:
  config:
    podReaper:
      enabled: true
      timeout: 5m
      interval: 1m

Pod ReaperLearn how to configure the pod reaper.

Install the new version of Kannika Armory

Install the new version of Kannika Armory using Helm:

$ helm upgrade --install kannika oci://quay.io/kannika/charts/kannika \
  --create-namespace \
  --namespace kannika-system \
  --version 0.17.0 \
  --values values.yaml

InstallationLearn how to install Kannika Armory

Disable maintenance mode

Once you have completed the upgrade process, disable maintenance mode by setting global.maintenance.enabled to false.

values.yaml

global:
  maintenance:
    enabled: false

Verify the installation

Verify that the upgrade was successful by checking the logs of the Kannika Armory components:

$ kubectl logs -n kannika-system -l app.kubernetes.io/name=kannika-operator # or operator
$ kubectl logs -n kannika-system -l app.kubernetes.io/name=kannika-api      # or api
$ kubectl logs -n kannika-system -l app.kubernetes.io/name=kannika-console  # or console

Verify that the backups are running as expected:

$ kubectl get backups -n [NAMESPACE]
$ kubectl get schemaregistrybackups -n [NAMESPACE]

If you encounter any issues during the upgrade process, do not hesitate to contact us on Slack.