DOC-1283 add rpk to config-cluster.adoc #278
Conversation
|
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 configuring Redpanda cluster properties was updated to provide clearer, more detailed instructions. The introduction was revised, and a new tabbed section was added to separate guidance for using the Changes
Assessment against linked issues
Suggested reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 rp-cloud 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 (6)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (6)
4-6: Refine introductory sentence for clarity
Current phrasing "are automatically set to the default values and are replicated across all brokers" is a bit wordy. Consider simplifying to improve readability.Apply this diff:
- Redpanda cluster configuration properties are automatically set to the default values and are replicated across all brokers. With cluster properties, you can enable and manage certain features, like xref:manage:iceberg/about-iceberg-topics.adoc[Iceberg topics], xref:develop:data-transforms/index.adoc[data transforms], and xref:manage:audit-logging.adoc[audit logging]. + Cluster configuration properties are set to their default values and automatically replicated across all brokers. You can use them to enable and manage features such as xref:manage:iceberg/about-iceberg-topics.adoc[Iceberg topics], xref:develop:data-transforms/index.adoc[data transforms], and xref:manage:audit-logging.adoc[audit logging].
15-18: Unify heading and layout consistency
The document title is "Configure Cluster Properties", but this section is titled "Set cluster configuration properties". For consistency, consider renaming it to "Configure cluster properties". Also ensure there’s a blank line after the heading before the tabs block.
31-31: Clarify restart phrasing
The sentence "Some properties require a cluster restart for updates to take effect." could be tightened. Consider:Some changes require a cluster restart to take effect.
57-61: Use modern command substitution and flag formatting
To improve readability, use$(...)for command substitution and standardize header flags. For example:-export RP_CLOUD_TOKEN=`curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/token" \ +export RP_CLOUD_TOKEN=$(curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/token" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=client_credentials" \ -d "client_id=<client-id>" \ -d "client_secret=<client-secret>")
63-69: Align cURL flags for readability
Thecurlsnippet has inconsistent indentation and flag order. Consider:-curl -H "Authorization: Bearer ${RP_CLOUD_TOKEN}" -X PATCH \ - "https://api.cloud.redpanda.com/v1/clusters/${RP_CLUSTER_ID}" \ - -H 'accept: application/json'\ - -H 'content-type: application/json' \ - -d '{"cluster_configuration":{"custom_properties": {"data_transforms_enabled":true}}}' +curl \ + -X PATCH "https://api.cloud.redpanda.com/v1/clusters/${RP_CLUSTER_ID}" \ + -H "Authorization: Bearer ${RP_CLOUD_TOKEN}" \ + -H "Accept: application/json" \ + -H "Content-Type: application/json" \ + -d '{"cluster_configuration":{"custom_properties":{"data_transforms_enabled":true}}}'
80-80: Add a descriptive label to the cross-reference
Using an empty bracket will default to the filename. To improve clarity, add a label:* xref:manage:rpk/intro-to-rpk.adoc[Intro to RPK]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/manage/pages/cluster-maintenance/config-cluster.adoc(1 hunks)
🔇 Additional comments (4)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (4)
19-22: Verify Asciidoc tab syntax for therpktab
The use of+and--as delimiters may not conform to Antora/AsciiDoc tab directives, which could break rendering. Please confirm in the Netlify preview that the "rpk" tab renders correctly. If not, swap--for the standard----literal block marker or remove the extraneous continuation marker.
24-24: Good cross-reference for the data_transforms_enabled property
The xref link todata_transforms_enabledis accurate and clear.
39-43: Verify Asciidoc tab syntax for the Cloud API section
As with the CLI tab, the Cloud API tab uses+and--markers. Ensure the Cloud API tab also renders correctly in preview. If not, update the delimiters (e.g., use----for literal blocks) or adjust the continuation marker.Also applies to: 75-75
49-49: Clear example introduction
The phrase "For example, to set ..." is consistent with the CLI tab and provides a clear lead-in to the code snippet.
Co-authored-by: Angela Simms <[email protected]>
| [source,bash] | ||
| ---- | ||
| # Store your cluster ID in a variable |
There was a problem hiding this comment.
Should this be an ordered list rather than # comments?
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (2)
47-58: Consider modernizing command substitution
You’re using backticks to capture the token. For improved readability and nesting support, consider switching to$(…), e.g.:-export RP_CLOUD_TOKEN=`curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/token" ...` +export RP_CLOUD_TOKEN=$(curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/token" ...)
75-75: Add descriptive link text for the rpk guide
The currentxref:manage:rpk/intro-to-rpk.adoc[]has an empty bracket. For clarity, specify a title, for example:* xref:manage:rpk/intro-to-rpk.adoc[Introduction to rpk]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/manage/pages/cluster-maintenance/config-cluster.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 (14)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (14)
4-4: Good clarification of cluster configuration properties
This introduction clearly explains how default properties are managed and replicates across brokers, and it highlights key features users can enable.
6-6: Helpful cross-reference to full property list
Linking to the complete set of cluster properties in Redpanda Cloud is a great way to direct users to detailed documentation.
10-10: Clear statement of supported platforms
The “Limitations” section now succinctly identifies where cluster configuration is supported, which will help readers quickly assess applicability.
15-15: Section header correctly introduces configuration methods
The new “Set cluster configuration properties” heading clearly marks the switch from overview to actionable instructions.
17-17: Nicely emphasizes both CLI and API options
Stating up front that users can chooserpkor the Cloud API prepares them for the upcoming tabbed interface.
19-24: Tabbed interface cleanly separates rpk vs. Cloud API instructions
The AsciiDoc markup appears correct, and this layout will improve readability by offering users two distinct workflows.
26-26: Example introduction is clear
You lead into therpkcode snippet with a concise explanation of what property is being toggled.
28-31: Correct CLI example aligns with property reference
Therpk cluster config set data_transforms_enabled truecommand is accurate and matches the link target above.
33-33: Clarify broker restart requirement after CLI config
Does usingrpk cluster config setrequire a manual broker restart for changes to take effect, or is it applied dynamically? Consider adding a short note to inform users.
35-39: Cloud API tab correctly formatted
The plus sign, block delimiters, and “Cloud API” label mirror therpktab setup—looks good.
45-45: Cloud API example introduction is clear
Leading with “For example, to set … totrue:” provides a consistent transition from explanation to code.
59-66: Clear curl example for updating cluster configuration
The PATCH request demonstrates all necessary headers and payload structure; users will appreciate the real-world example.
67-67: Good explanation of long-running operation semantics
Noting the need to poll the operations endpoint makes the async behavior explicit.
70-71: Proper closure of the tabs block
The final--and closing======correctly terminate the tabbed section.
asimms41
left a comment
asimms41
left a comment
There was a problem hiding this comment.
LGTM. No blockers, just suggestions.
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
Co-authored-by: Angela Simms <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (1)
41-44: 🛠️ Refactor suggestionClarify Cloud API use case
The first bullet shows how to create a cluster, which is out of scope for configuring an existing cluster's properties. Consider removing or moving the creation step and focusing this section solely on updating cluster configuration:-* Create a cluster by making a POST /v1/clusters request... +* (If you need to spin up a new cluster) create one via POST /v1/clusters... * Update a cluster by making a PATCH /v1/clusters/{cluster.id} request...
🧹 Nitpick comments (3)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (3)
24-24: Refinerpkcommand reference
The textUserpk cluster configto set cluster properties.could be more precise by referencing thesetsubcommand, e.g.:-Use `rpk cluster config` to set cluster properties. +Use the `rpk cluster config set` command to modify cluster properties.
53-57: Prefer modern command substitution
Using backticks for command substitution can be less readable and harder to nest. Recommend switching to$(...)syntax:-export RP_CLOUD_TOKEN=`curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/token" \ - -H "content-type: application/x-www-form-urlencoded" \ - -d "grant_type=client_credentials" \ - -d "client_id=<client-id>" \ - -d "client_secret=<client-secret>"` +export RP_CLOUD_TOKEN=$(curl -X POST "https://auth.prd.cloud.redpanda.com/oauth/token" \ + -H "content-type: application/x-www-form-urlencoded" \ + -d "grant_type=client_credentials" \ + -d "client_id=<client-id>" \ + -d "client_secret=<client-secret>")
75-75: Add a link text for theintro-to-rpkreference
The linkxref:manage:rpk/intro-to-rpk.adoc[]has an empty title. Consider adding descriptive text inside the brackets, e.g.:-* xref:manage:rpk/intro-to-rpk.adoc[] +* xref:manage:rpk/intro-to-rpk.adoc[Introduction to rpk]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/manage/pages/cluster-maintenance/config-cluster.adoc(1 hunks)
🔇 Additional comments (7)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (7)
4-4: Approve introduction clarity
The updated sentence concisely describes default values and replication behavior, and the feature links are clear.
10-10: Approve supported platforms clarification
The rephrased "Cluster configuration is supported on BYOC and Dedicated clusters running on AWS and GCP." is clear and accurate.
17-17: Approve introduction to configuration methods
The sentence succinctly introduces bothrpkand the Cloud API as options for setting cluster properties.
26-26: Approverpkexample introduction
The example clearly shows how to enabledata_transforms_enabledviarpk.
33-33: Approve note on operation ID and timing
TheNOTE:admonition correctly informs users about the operation ID and potential delay.
45-45: Approve Cloud API example introduction
The preamble for the Cloud API example is clear and correctly references thedata_transforms_enabledproperty.
67-67: Verify the operations endpoint path
The text referencesGET /operations/{id}, but the prefix/v1is omitted and the braces are escaped. Confirm whether it should be/v1/operations/{id}for consistency with earlier API calls.
| + | ||
| -- |
There was a problem hiding this comment.
Remove stray + delimiter lines
Lines containing just + appear to be artifacts and will render incorrectly in Asciidoc. Remove these lines so the tab definitions aren't broken.
Example diff:
- +
- +Committable suggestion skipped: line range outside the PR's diff.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (4)
15-17: Ensure heading style consistency
The heading “Set cluster configuration properties” is in sentence case, whereas other headings (e.g., “Configure Cluster Properties”) use title case. Consider updating to title case (“Set Cluster Configuration Properties”) to maintain a consistent style throughout the document.
24-24: Link therpk cluster configcommand to CLI reference
Consider adding a cross-reference to the detailedrpkCLI documentation (for example,xref:manage:rpk/intro-to-rpk.adoc[Intro to rpk]) or noting flags like--brokers/--cluster-idto guide users on targeting the intended cluster context.
33-33: Convert inline note into standard AsciiDoc admonition
To improve consistency, replace the inlineNOTE:with an AsciiDoc admonition block:[NOTE] ==== The `rpk cluster config set` command returns the operation ID. Cluster configuration operations can take up to ten minutes to complete. ====This will render a proper “Note” box rather than plain text.
39-39: Clarify the Cloud API workflow sequence
The Cloud API section begins with “Use the Cloud API to set cluster properties:” but the first step instructs creating a cluster. Since this page is focused on configuring an existing cluster, consider moving the “Create a cluster” bullet to its own section or reordering to lead with the update/PATCH workflow.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/manage/pages/cluster-maintenance/config-cluster.adoc(1 hunks)
🔇 Additional comments (3)
modules/manage/pages/cluster-maintenance/config-cluster.adoc (3)
4-4: Good: Clarify default behavior and cross-broker replication
The new intro clearly states default cluster property behavior and cross-broker replication, with helpful cross-references to Iceberg topics, data transforms, and audit logging.
10-10: Verify supported platforms apply to both methods
The limitations now state support for BYOC and Dedicated clusters on AWS and GCP; please confirm this applies equally to both therpkCLI and Cloud API methods, and clarify if necessary (e.g., add “via CLI or Cloud API” for consistency).
45-45: Example description is clear
The example correctly shows how to setdata_transforms_enabledtotrue, and the cross-reference to the property is accurate.
Description
This pull request adds
rpk cluster configfor configuring cluster properties. It also updates the What's New blurb to addrpkand removesrpk cluster configfrom the list of unsupported commands in Cloud.Clarifications on unsupported features:
rpkcommands in Redpanda Cloud deployments, removingrpk cluster configfrom the list of unsupported commands. (modules/get-started/pages/cloud-overview.adoc, modules/get-started/pages/cloud-overview.adocL244)Enhancements to cluster configuration documentation:
modules/manage/pages/cluster-maintenance/config-cluster.adoc, modules/manage/pages/cluster-maintenance/config-cluster.adocL4-R75)rpkand Cloud API, with detailed instructions for setting cluster properties usingrpk, including an example for enabling data transforms withrpk cluster config set. (modules/manage/pages/cluster-maintenance/config-cluster.adoc, modules/manage/pages/cluster-maintenance/config-cluster.adocL4-R75)Resolves https://redpandadata.atlassian.net/browse/DOC-1283
Review deadline:
Page previews
Configure Cluster Properties
Redpanda Cloud vs Self-Managed feature compatibility
What's New
Checks
Summary by CodeRabbit
rpkCLI and the Cloud API, with detailed examples and operational notes.rpkCLI in addition to the Cloud API.rpkcommands in Redpanda Cloud, removingrpk cluster configfrom the unsupported list.