bin/kc.[sh|bat] update-compatibility metadata --file=/path/to/file.jsonUse the update compatibility command to determine if you can update your deployment with a rolling update strategy when enabling or disabling features or changing the Keycloak version, configurations or providers and themes. The outcome shows whether a rolling update is possible or if a recreate update is required.
In its current version, it shows that a rolling update is possible when the Keycloak version is the same for the old and the new version. Future versions of Keycloak might change that behavior to use additional information from the configuration, the image and the version to determine if a rolling update is possible.
|
In the next iteration of this feature, it is possible to use rolling update strategy also when updating to the following patch release of Keycloak. Refer to Rolling updates for patch releases section for more details. |
This is fully scriptable, so your update procedure can use that information to perform a rolling or recreate strategy depending on the change performed. It is also GitOps friendly, as it allows storing the metadata of the previous configuration in a file. Use this file in a CI/CD pipeline with the new configuration to determine if a rolling update is possible or if a recreate update is needed.
If you are using the Keycloak Operator, continue to the Avoiding downtime with rolling updates guide and the Auto strategy for more information.
In this guide, a rolling update is an update that can be performed with zero downtime for your deployment, which consists of at least two nodes. Update your Keycloak one by one; shut down one of your old deployment nodes and start a new deployment node. Wait until the new node’s start-up probe returns success before proceeding to the next Keycloak node. See guide Tracking instance status with health checks for details on how to enable and use the start-up probe.
A recreate update is not compatible with zero-downtime and requires downtime to be applied. Shut down all nodes of the cluster running the old version before starting the nodes with the new version.
To determine if a rolling update is possible:
Run the update compatibility command to generate the required metadata with the old configuration.
Check the metadata with the new configuration to determine the update strategy.
If you do not use --optimized keep in mind that an update command may implicitly create or update an optimized build for you - if you are running the command from the same machine as a server instance, this may impact the next start of your server.
|
|
The The current version does not yet verify configuration changes and assumes all configuration changes are eligible for a rolling update. The same applies to changes to custom extensions and themes. A good use case when to use this is, for example, when you want to do a rolling update when you change the Keycloak theme or your custom extensions, and only want run recreate update when the version of Keycloak changes which does not yet allow a rolling update. While consumers of these commands should know the limitations that exist today, they should not rely on the internal behavior or the structure of the metadata file.
Instead, they should rely only on the exit code of the |
To generate the metadata, execute the following command using the same Keycloak version and configuration options:
bin/kc.[sh|bat] update-compatibility metadata --file=/path/to/file.jsonThis command accepts all options used by the start command.
The command displays the metadata, in JSON format, in the console for debugging purposes.
The --file parameter allows you to save the metadata to a file.
Use this file with the subsequent check command.
|
Ensure that all configuration options, whether set via environment variables or CLI arguments, are included when running the above command. Omitting any configuration options results in incomplete metadata, and could lead to a wrong reported result in the next step. |
This command checks the metadata generated by the previous command and compares it with the current configuration and Keycloak version. If you are updating to a new Keycloak version, this command must be executed with the new version.
bin/kc.[sh|bat] update-compatibility check --file=/path/to/file.json
Failure to meet these requirements results in an incorrect outcome. |
The command prints the result to the console. For example, if a rolling update is possible, it displays:
[OK] Rolling Update is available.If no rolling update is possible, the command provides details about the incompatibility:
[keycloak] Rolling Update is not available. 'keycloak.version' is incompatible: 26.2.0 -> 26.2.1 (1)| 1 | In this example, the Keycloak version 26.2.0 is not compatible with version 26.2.1 and a rolling update is not possible. |
|
In the next iteration of this feature, it is possible to use rolling update strategy also when updating to the following patch release of Keycloak. Refer to Rolling updates for patch releases section for more details. |
Command exit code
Use the command’s exit code to determine the update type in your automation pipeline:
| Exit Code | Description |
|---|---|
|
Rolling Update is possible. |
|
Unexpected error occurred (such as the metadata file is missing or corrupted). |
|
Invalid CLI option. |
|
Rolling Update is not possible. The deployment must be shut down before applying the new configuration. |
|
Rolling Update is not possible.
The feature |
| This behavior is currently in an experimental mode, and it is not recommended for use in production. |
It is possible to configure the Keycloak compatibility command to allow rolling updates when upgrading to a newer patch version in the same major.minor release stream.
To enable this behavior for compatibility check command enable feature rolling-updates:v2 as shown in the following example.
bin/kc.[sh|bat] update-compatibility check --file=/path/to/file.json --features=rolling-updates:v2Note there is no change needed when generating metadata using metadata command.
Recommended Configuration:
Enable sticky sessions in your loadbalancer to avoid users bouncing between different versions of Keycloak as this could result in users needing to refresh their Account Console and Admin UI multiple times while the upgrade is progressing.
Supported functionality during rolling updates:
Users can log in and log out for OpenID Connect clients.
OpenID Connect clients can perform all operations, for example, refreshing tokens and querying the user info endpoint.
Known limitations:
If there have been changes to the Account Console or Admin UI in the patch release, and the user opened the Account Console or Admin UI before or during the upgrade, the user might see an error message and be asked to reload the application while navigating in browser during or after the upgrade.
The Keycloak Operator uses the functionality described above to determine if a rolling update is possible. See the Avoiding downtime with rolling updates guide and the Auto strategy for more information.