Migration guide from multi-cluster - #51316
Conversation
Closes keycloak#50866 Signed-off-by: Ruchika <ruchika.jha1@ibm.com>
There was a problem hiding this comment.
Pull request overview
Adds step-by-step guidance for migrating multi-cluster v1 deployments to stateless v2.
Changes:
- Documents Kubernetes and bare-metal migration procedures.
- Covers data impact, component removal, verification, and operational changes.
- Links and pins the new migration guide.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
docs/guides/high-availability/pinned-guides |
Registers the migration guide. |
docs/guides/high-availability/multi-cluster-v2/migrate-from-v1-to-v2.adoc |
Adds the migration instructions. |
docs/guides/high-availability/multi-cluster-v2/introduction.adoc |
Links the guide from operational procedures. |
Closes keycloak#50866 Signed-off-by: Ruchika <ruchika.jha1@ibm.com>
ahus1
left a comment
There was a problem hiding this comment.
Thank you for the PR. See below for some suggestions.
Closes keycloak#50866 Signed-off-by: Ruchika <ruchika.jha1@ibm.com>
ahus1
left a comment
There was a problem hiding this comment.
Thank you for addressing my previous comments.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
Suppressed comments (3)
docs/guides/high-availability/multi-cluster-v2/migrate-from-v1-to-v2.adoc:172
- This decommissions Infinispan, fencing, and monitoring before the updated v2 deployment has started or passed verification, so a bad image or CR leaves no readily usable v1 rollback path. Keep the v1 infrastructure until after the deployment and verification steps complete, then perform this cleanup.
. Remove the {jdgserver_name} deployment.
docs/guides/high-availability/multi-cluster-v2/migrate-from-v1-to-v2.adoc:196
- The v1 procedure also creates
xsite-token-secretfor the remote site's service-account token, but this cleanup omits it and leaves that credential secret behind. Delete it along with the other cross-site secrets.
kubectl --namespace keycloak delete secret remote-store-secret
kubectl --namespace keycloak delete secret ispn-xsite-sa-token
kubectl --namespace keycloak delete secret xsite-keystore-secret
kubectl --namespace keycloak delete secret xsite-truststore-secret
docs/guides/high-availability/multi-cluster-v2/migrate-from-v1-to-v2.adoc:100
- Pending email-verification and password-reset links are self-contained action tokens, so they are not lost here; what is lost is the revocation metadata for already-consumed tokens, which can allow those tokens to be accepted again until expiry. Please describe that security impact separately from the OAuth authorization codes that are actually stored in this cache and become invalid.
This issue also appears in the following locations of the same file:
- line 172
- line 193
Action tokens in the {jdgserver_name} cache::
Email verification links, password reset tokens, and OAuth codes that were stored in {jdgserver_name} are lost.
Users with pending email verifications or password resets need to request new links.
This PR holds the changes for the doc for the migration from v1 .
Closes #50866
Signed-off-by: Ruchika ruchika.jha1@ibm.com