docs: upgrade guidance for shadow-linked clusters (DOC-2217) - #1819
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 <[email protected]>
|
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 <[email protected]>
Co-Authored-By: Claude Fable 5 <[email protected]>
This reverts commit e167629.
Co-Authored-By: Claude Fable 5 <[email protected]>
Wrap the page body in a single-source tag and gate self-managed-only content (enterprise license note, rolling-upgrade/rpk instructions, the deferred-finalization bidirectional procedure) behind env-cloud conditionals. Cloud renders the upgrade-order rule with maintenance- window sequencing guidance instead. Co-Authored-By: Claude Fable 5 <[email protected]>
This reverts commit 8302860.
PR Review (docs-team-standards)Overall: Clean, well-written how-to that complies with docs-team-standards. One merge-order dependency to gate on; everything else is minor. Critical (gate the merge)
All other xrefs and the four anchors resolve correctly, with correct module prefixes and no relative paths. Suggestions (minor)
Accuracy noteThe technical claims ( Impact on other files
What works well
|
micheleRP
left a comment
There was a problem hiding this comment.
left some suggestions but looks good!
Includes the merge of current beta (the What's New page was reset for 26.2 after this branch was cut). The Shadowing-topology xref resolves once DOC-2217 (#1819) merges into this branch. Co-Authored-By: Claude Fable 5 <[email protected]>
- Replace rpk redpanda admin brokers list (deprecated in 26.2, swept in #1832) with rpk cluster info -b --detailed in the Limitations bullet. - Move the Shadowing-topology sentence and xref out of the What's New entry: the target page ships in #1819, so this PR is now self-contained and can merge independently. #1819 re-adds the sentence alongside its page. Co-Authored-By: Claude Fable 5 <[email protected]>
…into DOC-2217-shadowing-upgrade
… New entry Moved here from #1818 (per review): the shadowing upgrade page ships in this PR, so the sentence and xref belong with it. Includes the merge of the updated base branch. Co-Authored-By: Claude Fable 5 <[email protected]>
- Move the upgrade page after the failover pages in nav (review question from Michele: failover is the core DR flow, upgrade is occasional maintenance). - Align the nav label and :description: with the page H1 vocabulary (clusters in a Shadowing topology). - Add the reciprocal Suggested reading link from deferred-finalization.adoc back to this page. Co-Authored-By: Claude Fable 5 <[email protected]>
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)