k8s - Create Cloud topics section and Whole Cluster Restore page for Cloud Topics page#1778
k8s - Create Cloud topics section and Whole Cluster Restore page for Cloud Topics page#1778david-yu wants to merge 9 commits into
Conversation
New how-to page documenting how to recover Cloud Topics onto a new Kubernetes cluster with Whole Cluster Restore: restore-on-bootstrap deployment (Operator + Helm), verification that topics return in cloud storage mode with their data, and the recovery-point caveat. Nav: Cloud Topics becomes a section with the new page nested under it, placed directly above Tiered Storage. Procedure validated end-to-end on Redpanda v26.1.12 (EKS, operator, 3 brokers cross-AZ): 10 MB/s produce, full cluster + PVC wipe, restore on bootstrap, byte-exact per-partition verification with zero loss. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. 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:
📝 WalkthroughWalkthroughThis PR adds a new documentation page describing Whole Cluster Restore for Cloud Topics, covering how it works, recovery point behavior, prerequisites, bootstrap steps for a target cluster, and verification procedures. Navigation entries in nav.adoc are reorganized to add a link to the new page under the existing Cloud Topics section, and the existing Cloud Topics page gains a suggested-reading link to the new page. Estimated code review effort: 2 (Simple) | ~10 minutes Changes
Related PRs: None identified. Suggested labels: documentation Suggested reviewers: None identified. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Mirror the Tiered Storage structure: Cloud Topics is now a section whose label opens a landing page (cloud-topics/index.adoc), with Use Cloud Topics and Whole Cluster Restore nested under it. The moved page keeps its old URL via page-aliases. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@modules/manage/pages/kubernetes/k-cloud-topics-whole-cluster-restore.adoc`:
- Around line 157-168: Update the restore verification example so the expected
topic-config output covers both valid sources, not only DYNAMIC_TOPIC_CONFIG. In
the Cloud Topics restore section, adjust the rpk topic describe <topic-name> -c
example to mention that redpanda.storage.mode can show cloud with either
DYNAMIC_TOPIC_CONFIG or DEFAULT_CONFIG, and keep the wording aligned with the
restore flow described in the surrounding topic-restore guidance.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c128aa3f-297e-424e-8a95-91ee39f9d437
📒 Files selected for processing (3)
modules/ROOT/nav.adocmodules/manage/pages/kubernetes/k-cloud-topics-whole-cluster-restore.adocmodules/manage/pages/kubernetes/k-cloud-topics.adoc
Concepts (how it works, storage modes, use cases, limitations) now live on the section landing page; Use Cloud Topics stays a pure how-to and links back to the index for the overview. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Same pattern as the Tiered Storage page: shared suggested-reading partial + empty-text xrefs so the theme renders each child page's title with its description. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This reverts commit d148c8a.
kbatuigas
left a comment
There was a problem hiding this comment.
Some suggestions, and I think the Coderabbit one is worth looking at as well.
…ole-cluster-restore.adoc Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
…ole-cluster-restore.adoc Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
…ole-cluster-restore.adoc Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
- Verification example: note the storage.mode source can be DEFAULT_CONFIG when inherited from the cluster default (CodeRabbit) - Add explicit note that "topics restore empty without archival" does not apply to Cloud Topics (kbatuigas) - Nav label: "Whole Cluster Restore for Cloud Topics" to distinguish it from the Tiered Storage WCR entry nearby (kbatuigas) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Should be ready for re-review. |
What
Adds a new how-to page, Restore Cloud Topics with Whole Cluster Restore (
manage:kubernetes/cloud-topics/k-cloud-topics-whole-cluster-restore.adoc), covering:redpanda.storage.mode=cloud) with their data and offsets, and are immediately writable.cloud_storage_attempt_cluster_restore_on_bootstrap: true(Operator + Helm tabs), includingcloud_topics_enabled: trueand the "fully destroy the previous cluster first" caution.rpk cluster storage restore status, storage-mode check, HWM check, produce probe) and turning the bootstrap-restore flag back off afterward.The generic procedure stays single-sourced in
manage:partial$whole-cluster-restore.adoc— this page xrefs it rather than duplicating it.Leftnav
Cloud Topics becomes its own tree mirroring the Tiered Storage structure, placed directly above Tiered Storage. The section label opens a new landing page (
cloud-topics/index.adoc,:page-layout: index):k-cloud-topics.adocmoved intocloud-topics/and keeps its old URL via:page-aliases:; the xref in the operator release notes is repointed. Also adds the new page to the Suggested reading list on the Use Cloud Topics page.Why
Cloud Topics (v26.1+) had no documented disaster-recovery story: the existing WCR page never mentions Cloud Topics, and its "topics without Tiered Storage enabled will be restored empty" wording implies cloud topics restore empty — they don't.
Validation
Procedure validated end-to-end on official Redpanda v26.1.12 (EKS 1.36, Redpanda Operator, 3 brokers cross-AZ, S3): 10 MB/s sustained produce (383,680 records / 6.29 GB, 0 errors) → producer quiesced → full cluster + PVC wipe → restore on bootstrap → all partitions byte-exact vs pre-wipe baseline (per-partition HWM, count, and sha256 content hash equal; 0 gaps), topic back in cloud mode, new produce continued at the next offset.
🤖 Generated with Claude Code