Document feature: Expose selected cluster configuration properties in cloud #295
Conversation
✅ Deploy Preview for rp-cloud 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 📝 WalkthroughWalkthroughThe changes reorganize and clarify documentation related to cluster configuration properties. In the cluster maintenance documentation, the description of cluster property behavior is separated from instructions on how to view them, and a new example command ( Assessment against linked issues
Possibly related PRs
Suggested reviewers
🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (2)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (2)
30-34:⚠️ Potential issueRemove diff artifact markers: There are stray
+and--markers in the tabs section, likely leftover from a patch. Remove these so that the tabs render correctly:[tabs] ====== `rpk`:: Use `rpk cluster config` to set cluster properties. ======
44-48:⚠️ Potential issueRemove leftover patch indicators: Similar diff markers (
--,+) are present before the Cloud API heading. Eliminate these artifacts to ensure the section renders properly:Cloud API:: Use the Cloud API to set cluster properties:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
modules/manage/pages/cluster-maintenance/config-cluster.adoc(1 hunks)modules/reference/pages/properties/cluster-properties.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (1)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (1)
4-7: Clear separation of description and feature list: The split into two paragraphs improves readability, and the xref links to Iceberg topics, data transforms, and audit logging appear correct.
…ster-configuration-properties-in-cloud-console # Conflicts: # modules/get-started/pages/whats-new-cloud.adoc
Co-authored-by: Jake Cahill <[email protected]>
alenkacz
left a comment
alenkacz
left a comment
There was a problem hiding this comment.
Left some comments. Thanks for the edits!
|
|
||
| For a complete list of the cluster properties available in Redpanda Cloud, see xref:reference:properties/cluster-properties.adoc[Cluster Configuration Properties] and xref:reference:properties/object-storage-properties.adoc[Object Storage Properties]. | ||
|
|
||
| NOTE: Some properties are read-only and cannot be changed. For example, `cluster_id` is a read-only property that is automatically set when the cluster is created. |
There was a problem hiding this comment.
we don't expose cluster_id so we should not mention that.
| "https://api.cloud.redpanda.com/v1/clusters/${RP_CLUSTER_ID}" \ | ||
| -H 'accept: application/json'\ | ||
| -H 'content-type: application/json' \ | ||
| -d '{"cluster_configuration":{"computed_properties": {"data_transforms_enabled"}}}' |
There was a problem hiding this comment.
http get has no body 🤔 I don't think this is correct
There was a problem hiding this comment.
@alenkacz please review the updated draft!
| @@ -0,0 +1,11 @@ | |||
| = Object Storage Properties | |||
There was a problem hiding this comment.
I don't understand what is this page about 🤔 Can I see it live somewhere?
There was a problem hiding this comment.
@alenkacz in our self-managed docs, we have tiered storage cluster properties on a separate page. See https://docs.redpanda.com/current/reference/properties/. But we have an open doc issue to consolidate the cluster properties and the object storage properties, so when that happens, all these properties available in Cloud will be on one page.
micheleRP
deleted the
DOC-190-Document-feature-Expose-selected-cluster-configuration-properties-in-cloud-console
branch
Description
This pull request adds read-only cluster config propeties in Redpanda Cloud. (2 are in the object storage properties reference)
Single sourcing of the SM content is done in redpanda-data/docs#1128
Cluster Configuration Documentation Enhancements:
modules/manage/pages/cluster-maintenance/config-cluster.adocto include information about read-only cluster properties, such ascluster_id, and clarified their behavior. Added a new section detailing how to view cluster property values usingrpkand the Cloud API. [1] [2]New Object Storage Properties:
modules/reference/pages/properties/object-storage-properties.adoc, to document object storage properties (e.g.,cloud_storage_azure_storage_accountandcloud_storage_azure_container). These properties are now referenced alongside cluster properties.Navigation and Reference Updates:
modules/ROOT/nav.adoc.modules/reference/pages/properties/cluster-properties.adocto include additional cluster properties, such ascluster_idand object storage-related properties.What's New Section:
modules/get-started/pages/whats-new-cloud.adocto highlight the ability to view read-only cluster configuration properties viarpkor the Cloud API.Antora Playbook Update:
local-antora-playbook.ymlto adjust the branch configuration for the documentation repository, replacing themainbranch with a specific feature branch.Resolves https://redpandadata.atlassian.net/browse/DOC-190
Review deadline: Monday May 19
Page previews
What's New
View cluster property values
Cluster Configuration Properties reference
Object Storage Properties reference
Checks