Skip to content

Migration guide from multi-cluster - #51316

Merged
ahus1 merged 3 commits into
keycloak:mainfrom
ruchikajha95:feature-50866/Migration-guide-from-multi-cluster
Aug 6, 2026
Merged

Migration guide from multi-cluster#51316
ahus1 merged 3 commits into
keycloak:mainfrom
ruchikajha95:feature-50866/Migration-guide-from-multi-cluster

Conversation

@ruchikajha95

Copy link
Copy Markdown
Contributor

This PR holds the changes for the doc for the migration from v1 .

Closes #50866

Signed-off-by: Ruchika ruchika.jha1@ibm.com

Closes keycloak#50866

Signed-off-by: Ruchika <ruchika.jha1@ibm.com>
@ruchikajha95
ruchikajha95 requested review from ahus1, pruivo and ryanemerson and a balanced review from Copilot August 4, 2026 08:58

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/guides/high-availability/multi-cluster-v2/migrate-from-v1-to-v2.adoc Outdated
Closes keycloak#50866

Signed-off-by: Ruchika <ruchika.jha1@ibm.com>
@ruchikajha95 ruchikajha95 self-assigned this Aug 4, 2026

@ahus1 ahus1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR. See below for some suggestions.

Comment thread docs/guides/high-availability/multi-cluster-v2/migrate-from-v1-to-v2.adoc Outdated
Comment thread docs/guides/high-availability/multi-cluster-v2/migrate-from-v1-to-v2.adoc Outdated
Comment thread docs/guides/high-availability/multi-cluster-v2/migrate-from-v1-to-v2.adoc Outdated
Comment thread docs/guides/high-availability/multi-cluster-v2/migrate-from-v1-to-v2.adoc Outdated
Closes keycloak#50866

Signed-off-by: Ruchika <ruchika.jha1@ibm.com>
@ruchikajha95
ruchikajha95 requested a review from ahus1 August 5, 2026 15:41
@ahus1
ahus1 marked this pull request as ready for review August 6, 2026 10:24
@ahus1
ahus1 requested review from a team as code owners August 6, 2026 10:24
Copilot AI review requested due to automatic review settings August 6, 2026 10:24

@ahus1 ahus1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for addressing my previous comments.

@ahus1
ahus1 merged commit 0dd4cfb into keycloak:main Aug 6, 2026
68 checks passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-secret for 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migration guide from multi-cluster (v1)

3 participants