29.5. Upgrading the Cluster Operator

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 2.8.

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

   On MacOS, use:

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

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>

     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

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

   oc replace -f install/cluster-operator

   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}'

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

   registry.redhat.io/amq-streams/strimzi-kafka-38-rhel9:2.8.0

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

1. Upgrade to Streams for Apache Kafka 1.7.
2. Download the Red Hat Streams for Apache Kafka API Conversion Tool provided with Streams for Apache Kafka 1.8 from the Streams for Apache Kafka software downloads page.

3. Convert custom resources and CRDs to v1beta2.

   For more information, see the Streams for Apache Kafka 1.7 upgrade documentation.

4. In the OperatorHub, delete version 1.7 of the Streams for Apache Kafka Operator.

5. If it also exists, delete version 2.8 of the Streams for Apache Kafka Operator.

   If it does not exist, go to the next step.

   If the Approval Strategy for the Streams for Apache Kafka Operator was set to Automatic, version 2.8 of the operator might already exist in your cluster. If you did not convert custom resources and CRDs to the v1beta2 API version before release, the operator-managed custom resources and CRDs will be using the old API version. As a result, the 2.8 Operator is stuck in Pending status. In this situation, you need to delete version 2.8 of the Streams for Apache Kafka Operator as well as version 1.7.

   If you delete both operators, reconciliations are paused until the new operator version is installed. Follow the next steps immediately so that any changes to custom resources are not delayed.

6. In the OperatorHub, do one of the following:

   • Upgrade to version 1.8 of the Streams for Apache Kafka Operator (where the ControlPlaneListener feature gate is disabled by default).
   • Upgrade to version 2.0 or 2.2 of the Streams for Apache Kafka Operator (where the ControlPlaneListener feature gate is enabled by default) with the ControlPlaneListener feature gate disabled.

7. Upgrade to version 2.8 of the Streams for Apache Kafka Operator immediately.

   The installed 2.8 operator begins to watch the cluster and performs rolling updates. You might notice a temporary decrease in cluster performance during this process.