#Upgrade

#Compatibility Matrix

The table below lists supported versions of the Alauda Streaming Service for Kafka and its key components:

#Prerequisites

Before initiating an upgrade, please ensure the following:

1. Version Compatibility: Your current version falls within a supported upgrade path.
2. Component Health: Kafka instances are in a Ready state.
3. Resource Availability: The cluster has sufficient resources to support the upgrade process.
4. KRaft Mode Verification: Verify that all rdskafka instances have spec.mode set to KRaft.
   • You can use the following command to check the mode of all Kafka instances:

     kubectl get rdskafka -A -o custom-columns="NAME:.metadata.name,NAMESPACE:.metadata.namespace,MODE:.spec.mode,PHASE:.status.phase"
   • If any instance is not in KRaft mode , you must migrate it to KRaft mode using the v4.1.x operator before upgrading to v4.2.x.
   • The v4.2.x operator does not support ZooKeeper mode and will not handle migration from ZooKeeper to KRaft.
   • A migration plan from ZooKeeper mode to Kraft mode is available (migrate to kraft).

For version-specific changes, new features, and deprecations, see the 📝 Release Notes.

#Upgrade Path Guidelines

#Consecutive Upgrade (Recommended)

• Description: Upgrade step-by-step through consecutive minor versions.
• Example: 4.1.x → 4.2.x

#Patch-Level Upgrade

• Description: Upgrades between any patch versions within the same minor version are fully compatible and can be performed directly.
• Example: 4.1.0 → 4.1.x

#Kafka Version Alignment

• Description: Ensure Kafka version upgrades follow the operator's compatibility matrix.
• Example:
  • Alauda Streaming Service for Kafka 4.1.x supports Kafka 3.8.1 or Kafka 2.8.2 (with plugin).

#Special Note for v4.2.x Upgrade

• KRaft Mode Requirement: All instances must be in KRaft mode before upgrading to v4.2.x.
• Migration Path: If you have instances in ZooKeeper mode:
  1. Stay on v4.1.x operator
  2. Migrate all instances to KRaft mode using the migration procedure
  3. Verify all instances are running successfully in KRaft mode
  4. Upgrade operator to v4.2.x
• No Rollback to ZooKeeper: Once migrated to KRaft mode, rolling back to ZooKeeper mode is not supported.

#Upgrade strategy

Alauda Streaming Service for Kafka will execute upgrades based on the configured upgrade strategy:

• Automatic : Auto-upgrades are triggered immediately upon detecting new component versions.
• Manual : Requires manual approval before initiating the upgrade process.