docs: upgrade guidance for shadow-linked clusters (DOC-2217)#1819
Open
Feediver1 wants to merge 4 commits into
Open
docs: upgrade guidance for shadow-linked clusters (DOC-2217)#1819Feediver1 wants to merge 4 commits into
Feediver1 wants to merge 4 commits into
Conversation
New shadowing page: the shadow-before-source upgrade ordering rule and the bidirectional-topology procedure built on deferred finalization (finalize both clusters promptly together, per SME guidance on the ticket). Adds a nav entry and a prerequisites TIP in setup.adoc, env-gated so the cloud-docs consuming build is unaffected. Stacked on DOC-2013-deferred-finalization (xrefs the new deferred-finalization page). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves https://redpandadata.atlassian.net/browse/DOC-2217
Adds upgrade guidance for shadow-linked clusters, including the bidirectional topology that motivated the ticket (Slack thread, May 2026; CORE-16390 is Backlogged, so documentation is the plan of record).
Stacked on #1818 (DOC-2013): this PR's base is the
DOC-2013-deferred-finalizationbranch because the new page xrefsupgrade:deferred-finalization.adocthroughout. Merge #1818 first; GitHub will retarget this PR tobetaautomatically. (If #1818 is squash-merged, I'll merge beta into this branch to clear the ghost diff before review.)Changes
modules/manage/pages/disaster-recovery/shadowing/upgrade.adoc:features_auto_finalization falseon both → roll cluster A, verify both link directions, roll cluster B, re-verify → soak → finalize both promptly together → restore auto-finalization → adopt new features only after both finalize.FAILED_PRECONDITIONerrors by design) and limitations (an unfinalized cluster blocks the next feature-release upgrade).setup.adoc: a TIP in the license/cluster requirements pointing to the new page, placed inside the existingifndef::env-cloud[]block so the cloud-docs consuming build is unaffected.Sources (no invented facts)
ShadowLinkUnfinalizedUpgradeTestCI coverage of replication across unfinalized upgrade + rollback, one-series-back rule, async finalize).Review notes
manage:kubernetes/shadowing/) has no parallel entry; the page covers Kubernetes via xrefs tok-rolling-upgrade.adoc. Can add a K8s-side pointer in a follow-up if wanted.🤖 Generated with Claude Code
Preview pages
Netlify does not build deploy previews for PRs based on a non-default branch, so no preview exists while this PR is stacked on
DOC-2013-deferred-finalization. Once #1818 merges and this PR retargets tobeta, the deploy preview will build and links will be added here for:manage/disaster-recovery/shadowing/upgrade/(new)manage/disaster-recovery/shadowing/setup/(updated)