DOC-1282 rpk cluster config for cloud wasm #1092
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 enabling data transforms on cloud clusters was updated to provide more comprehensive instructions. It now details two distinct methods—using the Changes
Poem
Assessment against linked issues
🪧 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 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: 2
🧹 Nitpick comments (4)
modules/develop/pages/data-transforms/build.adoc (4)
25-26: Suggestion: Correct grammar for consistency
Change the sentence to:
“Data transforms are disabled on all clusters by default.”
This aligns with plural usage of “transforms.”
27-29: Refine tab label formatting
The tab label uses backticks aroundrpk, but other tabs (e.g., Go::, Rust::) use plain text. To maintain consistency and ensure proper rendering, remove the backticks:- `rpk`:: + rpk::
37-44: Unify code block syntax and list continuation
The restart steps mix list items with AsciiDoc and Markdown. Use AsciiDoc list continuation and a[source,bash]block:-. Restart all brokers: -+ -[,bash] ----- -rpk redpanda stop -rpk redpanda start ----- +. Restart all brokers:: ++ +[source,bash] +---- +rpk redpanda stop +rpk redpanda start +----
51-69: Ensure consistent AsciiDoc code fencing and indentation
For the Cloud API curl snippet, use the standard[source,bash]block and align header flags under the curl command for readability:-,bash] ----- -# Store your cluster ID in a variable -export RP_CLUSTER_ID=<cluster-id> - -# Retrieve a Redpanda Cloud access 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>"` - -# Update cluster configuration to enable data transforms -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}}}' ----- +[source,bash] +---- +# Store your cluster ID in a variable +export RP_CLUSTER_ID=<cluster-id> + +# Retrieve a Redpanda Cloud access token +export RP_CLOUD_TOKEN=$(curl -s -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>") + +# Update cluster configuration to enable data transforms +curl -s -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}}}' +----
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/develop/pages/data-transforms/build.adoc(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
Description
This pull request adds steps for enabling data transforms in Redpanda Cloud using
rpk.data_transforms_enabledcluster property usingrpkor the Cloud API, including commands for setting the property and restarting brokers.rpkand Cloud API instructions.Resolves https://redpandadata.atlassian.net/browse/DOC-1282
Review deadline:
Page previews
Enable Data Transforms (in Redpanda Cloud)
Checks
Summary by CodeRabbit
rpkCLI and Cloud API methods.rpkwith improved formatting using a tabbed interface.