Upgrade
This document provides the upgrade path principles and supported version compatibility for Alauda Application Services Identity Management E1.
TOC
Compatibility MatrixPrerequisitesUpgrade Path GuidelinesConsecutive Upgrade (Recommended)Patch-Level UpgradeUpgrade ProcedureUpgrade StrategyCompatibility Matrix
The table below lists supported versions of Alauda Application Services Identity Management E1 and its key components. For version-specific changes, new features, and deprecations, see the Release Notes.
Prerequisites
Before initiating an upgrade, ensure the following:
- Version Compatibility: Your current version falls within a supported upgrade path.
- Instance Health: All Keycloak instances are in a
Readystate. - Database Backup: Create a backup of the PostgreSQL database before proceeding.
- Resource Availability: The cluster has sufficient resources to support the upgrade process.
Check the health of all Keycloak instances:
Upgrade Path Guidelines
Consecutive Upgrade (Recommended)
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.
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
- Log in to the platform and go to the Platform Management page.
- In the left navigation bar, select Marketplace > Cluster Plugins.
- Find Alauda Application Services Identity Management E1 and click Upgrade.
- Select the target version and confirm the upgrade.
- Monitor the Operator Pod status until it returns to
Running. - Verify that all Keycloak instances return to
Readystate.
Upgrade Strategy
Alauda Application Services Identity Management E1 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.
Keycloak™ is a trademark of The Linux Foundation. Alauda is an independent vendor. This product is not affiliated with, endorsed by, or sponsored by The Linux Foundation. All trademarks are the property of their respective owners and are used here for identification purposes only.