-
Notifications
You must be signed in to change notification settings - Fork 47
Doc-1601: Specify cluster UUID to restore with Whole Cluster Recovery #1513
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
✅ 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 You can disable this status message by setting the 📝 WalkthroughWalkthroughThis pull request adds comprehensive documentation to the Whole Cluster Restore section, covering behavior when multiple Redpanda clusters share the same object storage bucket. The changes explain the role of cluster UUIDs in manifest selection, provide naming conventions and examples for disambiguating clusters using Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
Comment |
|
|
@mattschumpert i'm fine with public doc unless it is a business/product concern. My argument is that our internal teams consume the same docs. There isn't anything to hide either. We already have this documented in the code. |
|
Up to you. We should be clear in the docs though this only occurs in extreme cases where multiple clusters have accidentally been sharing a bucket due to misconfiguration or a cluster lost quorum etc. I leave it to you / @andrwng to sort this out with @Feediver1 |
nvartolomei
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's beyond what I would have expected for us to have documented but looks great! 🤟
|
Based on some questions and comments Dais made to me, shared, below, I am in favor of documenting it publicly.
|
3a802fa to
ee3e148
Compare
|
|
||
| === Configure cluster names for multiple source clusters | ||
|
|
||
| To disambiguate cluster metadata from multiple clusters, use the xref:reference:properties/object-storage-properties.adoc#cloud_storage_cluster_name[`cloud_storage_cluster_name`] property (off by default), which allows you to assign a unique name to each cluster sharing the same object storage bucket. Redpanda uses this name to organize the cluster metadata within the shared object storage bucket. This ensures that each cluster's data remains distinct and prevents conflicts during recovery operations.The name must be unique within the bucket, 1-64 characters, and use only letters, numbers, underscores, and hyphens. Do not change this value once set. After setting, your object storage bucket organization may look like the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do not change this value once set.
Or what? What problems can this present? Is it recoverable? When the new name is set is it immediately used?
| +- rp-qux/uuid/<uuid-b> | ||
| ---- | ||
|
|
||
| During a Whole Cluster Restore, Redpanda looks for the cluster name specified in `cloud_storage_cluster_name` and only consider manifests associated with that name. Because the name specified here is `rp-qux`, Redpanda only considers manifests for the clusters `<uuid-b>` and `<uuid-c>`, ignoring cluster `<uuid-a>` entirely. In this case, your object storage bucket may look like the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What name for cloud_storage_cluster_name are we using here as an example? Is it rp-qux? If yes we could make this more clear.
UUID-C comes out of nowhere so we can explain that it's the new cluster in the narrative doc too
Co-authored-by: Paulo Borges <[email protected]>
review feedback Co-authored-by: Paulo Borges <[email protected]>
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1601
IIUC, this feature is for Redpanda Support. I included more detail to help Support when using this config. If not solely for support, I can remove all the explanations and just include a paragraph with a description of the config and what it does, along with a note telling users not to use it without contacting RP Support first.
Review deadline: Dec 19th
Page previews
(https://deploy-preview-1513--redpanda-docs-preview.netlify.app/current/manage/disaster-recovery/whole-cluster-restore/#advanced-restore-data-when-multiple-clusters-share-data)
Checks