#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. RDS Framework Version for v4.3.x: Ensure Alauda Container Platform Data Services RDS Framework is version 4.2.2 or later before upgrading Kafka instances to Kafka 4.2.0.
5. 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 or later.
   • The v4.2.x and later operators do 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 → 4.3.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.3.x supports Kafka 4.2.0.
  • Alauda Streaming Service for Kafka 4.2.x supports Kafka 4.1.2.
  • 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 and Later Upgrades

• KRaft Mode Requirement: All instances must be in KRaft mode before upgrading to v4.2.x or later.
• Kafka 2 Plugin Removal: Kafka 2.x instances and the Alauda build of Kafka 2 plugin are not supported in v4.2.x or later.
• 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 or later
• No Rollback to ZooKeeper: Once migrated to KRaft mode, rolling back to ZooKeeper mode is not supported.

#Special Note for v4.3.x Upgrade

• Kafka Runtime Upgrade: v4.3.x supports Kafka 4.2.0. Existing Kafka instances should be upgraded after the operator is healthy and the instance upgrade strategy allows it.
• RDS Framework Requirement: Kafka 4.2.0 support depends on Alauda Container Platform Data Services RDS Framework 4.2.2 or later. Verify the RDS Framework version before rolling Kafka instances to 4.2.0.
• Recommended Path: Upgrade from 4.2.x to 4.3.x first, verify operator and instance health, then roll Kafka instances to 4.2.0.

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