Upgrading with Streaming and Governance Charts

Changes in version 2024.3

General prerequisites

Before you upgrade to 2024.3, please make sure:

  • for the existing Tenant the wizardCompleted field is set to true in the self-service database

  • you are performing the deployment with any of the following Axual Streaming 2024.2 versions

    • Axual Streaming Charts 0.4.0 …​ 0.4.5

  • you are performing the deployment with any of the following Axual Governance 2024.2 versions

    • Axual Governance Charts 0.4.0 …​ 0.4.5

  • you are running kubernetes version 1.24.x or later

  • you are not overriding any components' versions (search for tag: overrides in your values.yaml)

You can upgrade each part of the Axual Platform independently, we suggest starting from the Streaming and then move to the Governance.

Axual Streaming

With the Axual Streaming Charts 1.0.0 we have updated the default kafka.version to 3.8.0 which requires Strimzi Operator 0.43.0 to be available in the k8s cluster.

In case you are not ready to upgrade your Kafka cluster version to 3.8.0, be sure that you are providing your running kafka.version and inter.broker.protocol.version in your values.yaml

Here an example of a values.yaml that is defining the kafka.version and inter.broker.protocol.version for a Kafka 3.4.0

values.yaml
axual-streaming:
  kafka:
    kafka:
      version: 3.4.0
      config:
        inter.broker.protocol.version: "3.4"

In case you are ready to upgrade your Kafka cluster version to 3.8.0, be sure that you do that before upgrading Axual Streaming to 1.0.0

General Steps to upgrade a Kafka cluster version to 3.8.0

This section provide an overview on how to upgrade a Kafka cluster to 3.8.0

The below steps are an indication of how the upgrade can be done.
For detailed steps, refer to Strimzi Upgrade docs or contact us to have a session to tailor the upgrade to your installation.

  1. upgrade Strimzi version to 0.37.0

  2. upgrade Kafka version from 3.4.0 to 3.5.1

  3. upgrade Strimzi version to 0.39.0

  4. upgrade Kafka version from 3.5.1 to 3.6.1

  5. upgrade Strimzi version to 0.42.0

  6. upgrade Kafka version from 3.6.1 to 3.7.1

  7. upgrade Strimzi version to 0.43.0

  8. upgrade Kafka version from 3.7.1 to 3.8.0

Performing the upgrade

Start from Axual Streaming 2024.2 installed using Axual Streaming Charts 0.4.0 …​ 0.4.5.

Use the general upgrade steps for upgrading best-practice.

Upgrade Axual Streaming to 1.0.0

  1. Update the Axual helm repository to download the latest charts available

    helm repo update

  2. Upgrade the Axual Streaming installation

    helm upgrade --install streaming axual-stable/axual-streaming --version=1.0.0 -n kafka

This command will restart all streaming pods.

Once restarted, verify everything is running fine before considering the upgrade done.

Axual Governance Charts

With the Axual Governance Charts 0.5.0 we have added to the Keycloak deployment an extraInitContainers that pulls our Axual Keycloak Themes.

Before starting with the Axual Governance upgrade, please add your docker image pull secrets within the keycloak section.

Here an example of a values.yaml that is providing the docker image pull secrets to Keycloak deployment

values.yaml
axual-governance:
  ## Keycloak
  keycloak:
    imagePullSecrets:
      - name: [your docker image pull secrets]

Performing the upgrade

Start from Axual Governance 2024.2 installed using Axual Governance Charts 0.4.0 …​ 0.4.5.

Use the general upgrade steps for upgrading best-practice.

Upgrade Axual Governance to 0.5.0

  1. Update the Axual helm repository to download the latest charts available

    helm repo update

  2. Upgrade the Axual Governance installation

    helm upgrade --install governance axual-stable/axual-governance --version=0.5.0 -n kafka

This command will restart all governance pods.

Once restarted, verify everything is running fine before considering the upgrade done.