Add metadata to cluster properties that don't get restored after a whole cluster restore procedure#1095
Add metadata to cluster properties that don't get restored after a whole cluster restore procedure#1095JakeSCahill merged 3 commits intomainfrom
Conversation
…ole cluster restore procedure
|
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 📝 WalkthroughWalkthroughThe documentation for cluster and object storage properties was updated to include a new attribute, "Gets restored during cluster restore: No", for various properties. This addition clarifies which configuration properties are not restored during a cluster restore operation. The changes are purely additive, affecting only documentation text and property metadata annotations, with no modifications to property functionality, signatures, or behavior. Changes
Assessment against linked issues
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
modules/reference/pages/properties/object-storage-properties.adoc (1)
120-126: Annotatecloud_storage_azure_containerrestore behaviorThe restore attribute is helpful, but note that this block uses “Restart required” instead of the standard “Requires restart” header seen elsewhere. Consider renaming to
*Requires restart:* Yesfor consistency.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
modules/reference/pages/properties/cluster-properties.adoc(1 hunks)modules/reference/pages/properties/object-storage-properties.adoc(14 hunks)
🔇 Additional comments (13)
modules/reference/pages/properties/object-storage-properties.adoc (12)
36-40: Add restore behavior annotation forcloud_storage_api_endpointIncluding “Gets restored during cluster restore: No” makes it explicit that this endpoint configuration isn’t preserved during a restore operation. This improves clarity for operators.
84-90: Annotatecloud_storage_azure_adls_endpointrestore behaviorThe new attribute clearly indicates that the ADLS endpoint override won’t be restored, aligning this property with the documented cluster restore semantics.
100-105: Document non-restoration ofcloud_storage_azure_adls_portAdding “Gets restored during cluster restore: No” for the ADLS port override ensures users know it won’t be reapplied after restore.
174-180: Markcloud_storage_azure_shared_keyas non-restoredUsers should be aware that the shared key isn’t automatically reapplied on restore—this attribute makes that explicit.
190-196: Clarify non-restoration ofcloud_storage_azure_storage_accountThe new attribute ensures clarity that the storage account setting must be reset post-restore if needed.
206-212: Add restore info forcloud_storage_backendDocumenting that the chosen backend variant isn’t preserved during restore is a valuable operator hint.
240-246: Annotatecloud_storage_bucketas non-restoredExplicitly stating that the bucket setting won’t survive a restore prevents unexpected data-loss scenarios.
350-356: Document non-restoration ofcloud_storage_cache_sizeAdding the restore attribute for cache size helps users understand post-restore reconfiguration needs.
540-546: Annotatecloud_storage_credentials_hostrestore behaviorNow it’s clear that custom credential host settings aren’t reapplied automatically.
559-567: Markcloud_storage_credentials_sourceas non-restoredThis addition clarifies that the IAM credential source must be reconfigured after a restore.
1378-1386: Add restore annotation forcloud_storage_regionMaking it explicit that region settings aren’t restored reduces confusion during disaster recovery.
1430-1438: Document non-restoration ofcloud_storage_secret_keyThis attribute ensures operators re-supply the secret key if required after a cluster restore.
modules/reference/pages/properties/cluster-properties.adoc (1)
301-307: Annotatecluster_idas non-restoredAdding “Gets restored during cluster restore: No” makes it explicit that the cluster identifier must be reset manually post-restore.
modules/reference/pages/properties/object-storage-properties.adoc
Outdated
Show resolved
Hide resolved
|
|
||
| *Gets restored during cluster restore:* No | ||
|
|
||
| *Accepted values*: `config_file`, `aws_instance_metadata`, `sts, gcp_instance_metadata`, `azure_vm_instance_metadata`, `azure_aks_oidc_federation` |
There was a problem hiding this comment.
Accepted values appear in [] in other entries.
asimms41
left a comment
asimms41
left a comment
There was a problem hiding this comment.
LGTM. Just a couple of minor comments about consistency.
Co-authored-by: Angela Simms <102690377+asimms41@users.noreply.github.com>
3 participants
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1285
Review deadline: April 30
This pull request updates documentation for cluster and object storage properties by adding a new attribute, "Gets restored during cluster restore," to clarify whether specific properties are restored during a cluster restore operation. Additionally, some formatting adjustments were made for consistency.
Documentation Updates:
New Attribute Added:
cluster-properties.adocandobject-storage-properties.adocfiles to indicate that these properties are not restored during a cluster restore. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]Formatting Adjustments:
object-storage-properties.adocto ensure consistent ordering of attributes. [1] [2]Page previews
Checks
Summary by CodeRabbit