Alauda Build of Keycloak

Upgrade

NOTE

This document provides the upgrade path principles and supported version compatibility for Alauda Build of Keycloak.

TOC

Compatibility MatrixPrerequisitesUpgrade Path GuidelinesConsecutive Upgrade (Recommended)Patch-Level UpgradeUpgrade ProcedureUpgrade Strategy

Compatibility Matrix

The table below lists supported versions of Alauda Build of Keycloak and its key components. For version-specific changes, new features, and deprecations, see the Release Notes.

Alauda Build of Keycloak VersionKeycloak VersionKubernetes Version
v26.4.7-2026012111381126.4.71.25+

Prerequisites

Before initiating an upgrade, ensure the following:

  1. Version Compatibility: Your current version falls within a supported upgrade path.
  2. Instance Health: All Keycloak instances are in a Ready state.
  3. Database Backup: Create a backup of the PostgreSQL database before proceeding.
  4. Resource Availability: The cluster has sufficient resources to support the upgrade process.

Check the health of all Keycloak instances:

kubectl get keycloak -A -o custom-columns="NAME:.metadata.name,NAMESPACE:.metadata.namespace,READY:.status.conditions[?(@.type=='Ready')].status"

Upgrade Path Guidelines

Upgrade step-by-step through consecutive versions to ensure compatibility.

Patch-Level Upgrade

Upgrades between patch versions within the same minor version are fully compatible and can be performed directly without additional migration steps.

No Rollback After Upgrade

Once the Operator upgrades and applies database schema migrations, downgrading to the previous Keycloak version is not supported. The database schema is updated during the upgrade process and is not backward compatible. Always back up the PostgreSQL database before upgrading.

Upgrade Procedure

Web Console
CLI
  1. Log in to the platform and go to the Platform Management page.
  2. In the left navigation bar, select Marketplace > Cluster Plugins.
  3. Find Alauda Build of Keycloak and click Upgrade.
  4. Select the target version and confirm the upgrade.
  5. Monitor the Operator Pod status until it returns to Running.
  6. Verify that all Keycloak instances return to Ready state.

Upgrade Strategy

Alauda Build of Keycloak executes upgrades based on the configured upgrade strategy in the Operator subscription:

  • Automatic: Auto-upgrades are triggered immediately upon detecting a new Operator version in the channel. Not recommended for production — automatic upgrades bypass manual review of release notes and database migration changes.
  • Manual: Requires manual approval before initiating the upgrade process. This is the recommended strategy for production environments.