Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 10. AMQ Streams resource upgrades

For this release of AMQ Streams, resources that use the API version kafka.strimzi.io/v1alpha1 must be updated to use kafka.strimzi.io/v1beta1.

The kafka.strimzi.io/v1alpha1 API version is deprecated in release 1.2.

This section describes the upgrade steps for the resources.

Important

The upgrade of resources must be performed after upgrading the Cluster Operator, so the Cluster Operator can understand the resources.

What if the resource upgrade does not take effect?

If the upgrade does not take effect, a warning is given in the logs on reconciliation to indicate that the resource cannot be updated until the apiVersion is updated.

To trigger the update, make a cosmetic change to the custom resource, such as adding an annotation.

Example annotation: 

metadata:
  # ...
  annotations:
    upgrade: "Upgraded to kafka.strimzi.io/v1beta1"
Copy to Clipboard Toggle word wrap

10.1. Upgrading Kafka resources
Copy link

Prerequisites

  • A Cluster Operator supporting the v1beta1 API version is up and running.

Procedure

Execute the following steps for each Kafka resource in your deployment.

  1. Update the Kafka resource in an editor. 

    oc edit kafka my-cluster
    Copy to Clipboard Toggle word wrap

  2. Replace: 

    apiVersion: kafka.strimzi.io/v1alpha1
    Copy to Clipboard Toggle word wrap

    with: 

    apiVersion:kafka.strimzi.io/v1beta1
    Copy to Clipboard Toggle word wrap

  3. If the Kafka resource has: 

    Kafka.spec.topicOperator
    Copy to Clipboard Toggle word wrap

    Replace it with: 

    Kafka.spec.entityOperator.topicOperator
    Copy to Clipboard Toggle word wrap

    For example, replace: 

    spec:
  # ...
  topicOperator: {}
    Copy to Clipboard Toggle word wrap

    with: 

    spec:
  # ...
  entityOperator:
    topicOperator: {}
    Copy to Clipboard Toggle word wrap

  4. If present, move: 

    Kafka.spec.entityOperator.affinity
    Copy to Clipboard Toggle word wrap 
    Kafka.spec.entityOperator.tolerations
    Copy to Clipboard Toggle word wrap

    to: 

    Kafka.spec.entityOperator.template.pod.affinity
    Copy to Clipboard Toggle word wrap 
    Kafka.spec.entityOperator.template.pod.tolerations
    Copy to Clipboard Toggle word wrap

    For example, move: 

    spec:
  # ...
  entityOperator:
    affinity {}
    tolerations {}
    Copy to Clipboard Toggle word wrap

    to: 

    spec:
  # ...
  entityOperator:
    template:
      pod:
        affinity {}
        tolerations {}
    Copy to Clipboard Toggle word wrap

  5. If present, move: 

    Kafka.spec.kafka.affinity
    Copy to Clipboard Toggle word wrap 
    Kafka.spec.kafka.tolerations
    Copy to Clipboard Toggle word wrap

    to: 

    Kafka.spec.kafka.template.pod.affinity
    Copy to Clipboard Toggle word wrap 
    Kafka.spec.kafka.template.pod.tolerations
    Copy to Clipboard Toggle word wrap

    For example, move: 

    spec:
  # ...
  kafka:
    affinity {}
    tolerations {}
    Copy to Clipboard Toggle word wrap

    to: 

    spec:
  # ...
  kafka:
    template:
      pod:
        affinity {}
        tolerations {}
    Copy to Clipboard Toggle word wrap

  6. If present, move: 

    Kafka.spec.zookeeper.affinity
    Copy to Clipboard Toggle word wrap 
    Kafka.spec.zookeeper.tolerations
    Copy to Clipboard Toggle word wrap

    to: 

    Kafka.spec.zookeeper.template.pod.affinity
    Copy to Clipboard Toggle word wrap 
    Kafka.spec.zookeeper.template.pod.tolerations
    Copy to Clipboard Toggle word wrap

    For example, move: 

    spec:
  # ...
  zookeeper:
    affinity {}
    tolerations {}
    Copy to Clipboard Toggle word wrap

    to: 

    spec:
  # ...
  zookeeper:
    template:
      pod:
        affinity {}
        tolerations {}
    Copy to Clipboard Toggle word wrap
  7. Save the file, exit the editor and wait for the updated resource to be reconciled.

10.2. Upgrading Kafka Connect resources
Copy link

Prerequisites

  • A Cluster Operator supporting the v1beta1 API version is up and running.

Procedure

Execute the following steps for each KafkaConnect resource in your deployment.

  1. Update the KafkaConnect resource in an editor. 

    oc edit kafkaconnect my-connect
    Copy to Clipboard Toggle word wrap

  2. Replace: 

    apiVersion: kafka.strimzi.io/v1alpha1
    Copy to Clipboard Toggle word wrap

    with: 

    apiVersion:kafka.strimzi.io/v1beta1
    Copy to Clipboard Toggle word wrap

  3. If present, move: 

    KafkaConnect.spec.affinity
    Copy to Clipboard Toggle word wrap 
    KafkaConnect.spec.tolerations
    Copy to Clipboard Toggle word wrap

    to: 

    KafkaConnect.spec.template.pod.affinity
    Copy to Clipboard Toggle word wrap 
    KafkaConnect.spec.template.pod.tolerations
    Copy to Clipboard Toggle word wrap

    For example, move: 

    spec:
  # ...
  affinity {}
  tolerations {}
    Copy to Clipboard Toggle word wrap

    to: 

    spec:
  # ...
  template:
    pod:
      affinity {}
      tolerations {}
    Copy to Clipboard Toggle word wrap
  4. Save the file, exit the editor and wait for the updated resource to be reconciled.

10.3. Upgrading Kafka Connect S2I resources
Copy link

Prerequisites

  • A Cluster Operator supporting the v1beta1 API version is up and running.

Procedure

Execute the following steps for each KafkaConnectS2I resource in your deployment.

  1. Update the KafkaConnectS2I resource in an editor. 

    oc edit kafkaconnects2i my-connect
    Copy to Clipboard Toggle word wrap

  2. Replace: 

    apiVersion: kafka.strimzi.io/v1alpha1
    Copy to Clipboard Toggle word wrap

    with: 

    apiVersion:kafka.strimzi.io/v1beta1
    Copy to Clipboard Toggle word wrap

  3. If present, move: 

    KafkaConnectS2I.spec.affinity
    Copy to Clipboard Toggle word wrap 
    KafkaConnectS2I.spec.tolerations
    Copy to Clipboard Toggle word wrap

    to: 

    KafkaConnectS2I.spec.template.pod.affinity
    Copy to Clipboard Toggle word wrap 
    KafkaConnectS2I.spec.template.pod.tolerations
    Copy to Clipboard Toggle word wrap

    For example, move: 

    spec:
  # ...
  affinity {}
  tolerations {}
    Copy to Clipboard Toggle word wrap

    to: 

    spec:
  # ...
  template:
    pod:
      affinity {}
      tolerations {}
    Copy to Clipboard Toggle word wrap
  4. Save the file, exit the editor and wait for the updated resource to be reconciled.

10.4. Upgrading Kafka Mirror Maker resources
Copy link

Prerequisites

  • A Cluster Operator supporting the v1beta1 API version is up and running.

Procedure

Execute the following steps for each KafkaMirrorMaker resource in your deployment.

  1. Update the KafkaMirrorMaker resource in an editor. 

    oc edit kafkamirrormaker my-connect
    Copy to Clipboard Toggle word wrap

  2. Replace: 

    apiVersion: kafka.strimzi.io/v1alpha1
    Copy to Clipboard Toggle word wrap

    with: 

    apiVersion:kafka.strimzi.io/v1beta1
    Copy to Clipboard Toggle word wrap

  3. If present, move: 

    KafkaConnectMirrorMaker.spec.affinity
    Copy to Clipboard Toggle word wrap 
    KafkaConnectMirrorMaker.spec.tolerations
    Copy to Clipboard Toggle word wrap

    to: 

    KafkaConnectMirrorMaker.spec.template.pod.affinity
    Copy to Clipboard Toggle word wrap 
    KafkaConnectMirrorMaker.spec.template.pod.tolerations
    Copy to Clipboard Toggle word wrap

    For example, move: 

    spec:
  # ...
  affinity {}
  tolerations {}
    Copy to Clipboard Toggle word wrap

    to: 

    spec:
  # ...
  template:
    pod:
      affinity {}
      tolerations {}
    Copy to Clipboard Toggle word wrap
  4. Save the file, exit the editor and wait for the updated resource to be reconciled.

10.5. Upgrading Kafka Topic resources
Copy link

Prerequisites

  • A Topic Operator supporting the v1beta1 API version is up and running.

Procedure

Execute the following steps for each KafkaTopic resource in your deployment.

  1. Update the KafkaTopic resource in an editor. 

    oc edit kafkatopic my-topic
    Copy to Clipboard Toggle word wrap

  2. Replace: 

    apiVersion: kafka.strimzi.io/v1alpha1
    Copy to Clipboard Toggle word wrap

    with: 

    apiVersion:kafka.strimzi.io/v1beta1
    Copy to Clipboard Toggle word wrap
  3. Save the file, exit the editor and wait for the updated resource to be reconciled.

10.6. Upgrading Kafka User resources
Copy link

Prerequisites

  • A User Operator supporting the v1beta1 API version is up and running.

Procedure

Execute the following steps for each KafkaUser resource in your deployment.

  1. Update the KafkaUser resource in an editor. 

    oc edit kafkauser my-user
    Copy to Clipboard Toggle word wrap

  2. Replace: 

    apiVersion: kafka.strimzi.io/v1alpha1
    Copy to Clipboard Toggle word wrap

    with: 

    apiVersion:kafka.strimzi.io/v1beta1
    Copy to Clipboard Toggle word wrap
  3. Save the file, exit the editor and wait for the updated resource to be reconciled.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat