docs: add keycloak update guide #177
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| id: keycloak-26-to-26 | ||
| sidebar_position: 8 | ||
| title: Keycloak Upgrade 26.X.Y -> 26.X.Y | ||
| description: Upgrade Keycloak from 26.4.5 to 26.5.6 | ||
| pagination_next: null | ||
| --- | ||
|
|
||
| # Upgrade Keycloak from 26.4.5 to 26.5.6 | ||
|
|
||
| The full description of Keycloak migration changes available [here](https://www.keycloak.org/docs/latest/upgrading/index.html#migration-changes). | ||
|
|
||
| ## Pre-Upgrade Requirements | ||
|
|
||
| **Before proceeding with any upgrade, ensure you have:** | ||
|
|
||
| - Planned for potential downtime | ||
| - Tested the upgrade process in a non-production environment | ||
|
|
||
| **Before starting the upgrade** | ||
|
|
||
| - Check the list of available chart versions: | ||
|
|
||
| ```bash | ||
| helm search repo codecentric/keycloakx --versions | ||
| ``` | ||
|
|
||
| :::info | ||
|
|
||
| > The Helm chart version and the application version may differ. | ||
| > All the component's version included in the helm chart might be different from **APP VERSION**. | ||
| > Always rely on the **Chart version** when determining compatibility and deployment behavior. | ||
|
|
||
| ::: | ||
|
|
||
| | NAME | CHART VERSION | APP VERSION | DESCRIPTION | | ||
|
Collaborator
There was a problem hiding this comment. What this table shows related to KC upgrade from 26.4.5 to 26.5.6?
Collaborator
There was a problem hiding this comment. It's just an example. |
||
| | ----------------------- | ------------- | ----------- | -------------------------------------------------- | | ||
| | `codecentric/keycloakx` | `7.1.9` | `26.5.5` | Keycloak.X - Open Source Identity and Access Ma... | | ||
| | `codecentric/keycloakx` | `7.1.8` | `26.5.3` | Keycloak.X - Open Source Identity and Access Ma... | | ||
|
|
||
| - Once you identify the target chart version, you can inspect the container image tags used in that release: | ||
|
Collaborator
There was a problem hiding this comment. If you want to describe |
||
|
|
||
| ```bash | ||
| helm show values codecentric/keycloakx --version <TARGET_CHART_VERSION> | grep -A 4 image: | ||
| ``` | ||
|
|
||
| > This helps verify the underlying images before proceeding with the upgrade. | ||
|
|
||
| ## Changes for `keycloak-helm/Chart.yaml` | ||
|
|
||
| | Parameter | Current Value | New Value | | ||
| | ---------------------- | ------------- | --------- | | ||
| | version | 2.1.5 | 7.1.9 | | ||
| | appVersion | 26.4.5 | 26.5.6 | | ||
| | dependencies[].version | 7.1.5 | 7.1.9 | | ||
|
|
||
| ## Changes for `keycloak-helm/values-<cloud_name>.yaml` | ||
|
|
||
| ### Settings to be added | ||
|
|
||
| ```yaml | ||
| keycloakx: | ||
| image: | ||
| tag: 26.5.6 | ||
| ``` | ||
|
|
||
| :::warning IMPORTANT | ||
| Ensure `keycloak-helm/Chart.lock` file and `keycloak-helm/charts/` directory do not exist before apply changes. | ||
| ::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please, use exact versions instead of generic. It's possible that in some future version upgrade procedure might include additional steps or configuration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's discuss this approach. I've scheduled a call.