Chapter 31. Upgrading Streams for Apache Kafka

Procedure

1. Take note of any configuration changes made during the previous Cluster Operator installation.

   Any changes will be overwritten by the new version of the Cluster Operator.

2. Update your custom resources to reflect the supported configuration options available for Streams for Apache Kafka version 3.1.

3. Modify the installation files for the new Cluster Operator version to reflect the namespace in which the Cluster Operator is running.

   On Linux, use:

   sed -i 's/namespace: .*/namespace: my-cluster-operator-namespace/' install/cluster-operator/*RoleBinding*.yaml

   Copy to Clipboard Toggle word wrap

   On MacOS, use:

   sed -i '' 's/namespace: .*/namespace: my-cluster-operator-namespace/' install/cluster-operator/*RoleBinding*.yaml

   Copy to Clipboard Toggle word wrap

4. If you modified environment variables in the Deployment configuration, edit the 060-Deployment-strimzi-cluster-operator.yaml file to use those environment variables.

   • If the Cluster Operator is watching multiple namespaces, add the list of namespaces to the STRIMZI_NAMESPACE environment variable.
   • If the Cluster Operator is watching all namespaces, specify value: "*" for the STRIMZI_NAMESPACE environment variable.

5. If the Cluster Operator is watching more than one namespace, update the role bindings.

   • If watching multiple namespaces, replace the namespace in the RoleBinding installation files with the actual namespace name and create the role bindings for each namespace:

     Creating role bindings for a namespace

     oc create -f install/cluster-operator/020-RoleBinding-strimzi-cluster-operator.yaml -n <watched_namespace>
     oc create -f install/cluster-operator/023-RoleBinding-strimzi-cluster-operator.yaml -n <watched_namespace>
     oc create -f install/cluster-operator/031-RoleBinding-strimzi-cluster-operator-entity-operator-delegation.yaml -n <watched_namespace>

     Copy to Clipboard Toggle word wrap

     For example, if the Cluster Operator is watching three namespaces, create three sets of role bindings by substituting <watched_namespace> with the name of each namespace.

   • If watching all namespaces, recreate the cluster role bindings that grant cluster-wide access (if needed):

     Granting cluster-wide access using role bindings

     oc create clusterrolebinding strimzi-cluster-operator-namespaced --clusterrole=strimzi-cluster-operator-namespaced --serviceaccount my-cluster-operator-namespace:strimzi-cluster-operator
     oc create clusterrolebinding strimzi-cluster-operator-watched --clusterrole=strimzi-cluster-operator-watched --serviceaccount my-cluster-operator-namespace:strimzi-cluster-operator
     oc create clusterrolebinding strimzi-cluster-operator-entity-operator-delegation --clusterrole=strimzi-entity-operator --serviceaccount my-cluster-operator-namespace:strimzi-cluster-operator

     Copy to Clipboard Toggle word wrap

6. When you have an updated configuration, deploy it along with the rest of the installation resources:

   oc replace -f install/cluster-operator

   Copy to Clipboard Toggle word wrap

   Wait for the rolling updates to complete.

7. If the new operator version no longer supports the Kafka version you are upgrading from, an error message is returned.

   To resolve this, upgrade to a supported Kafka version:

   1. Edit the Kafka custom resource.
   2. Change the spec.kafka.version property to a supported Kafka version.

   If no error message is returned, you can proceed to the next step and upgrade the Kafka version later.

8. Get the image for the Kafka pod to ensure the upgrade was successful:

   oc get pods my-cluster-kafka-0 -o jsonpath='{.spec.containers[0].image}'

   Copy to Clipboard Toggle word wrap

   The image tag shows the new Streams for Apache Kafka version followed by the Kafka version:

   registry.redhat.io/amq-streams/strimzi-kafka-41-rhel9:3.1.0

   Copy to Clipboard Toggle word wrap

   You can also check the upgrade has completed successfully from the status of the Kafka resource.