Clarify which cluster properties are configurable in Redpanda Cloud#627
Conversation
Document that only the properties listed in the Cloud reference can be set via rpk, the Cloud API, or the Terraform provider, and that setting others (for example, kafka_batch_max_bytes) returns REASON_INVALID_INPUT. Add a Terraform "Configure cluster properties" section with the cluster_configuration custom_properties_json syntax, and point users to topic-level max.message.bytes for message size. Correct the topic property name to max.message.bytes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ 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 ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis change updates documentation to correct the topic property name for configuring maximum message size from Estimated code review effort: 2 (Simple) | ~10 minutes Changes
Related issues: None specified. Related PRs: None specified. Suggested labels: documentation Suggested reviewers: None specified. 🐰 Nibbling docs with care, a property renamed just right — 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Scope the REASON_INVALID_INPUT claim to the Cloud API and Terraform provider (the paths evidenced in the field report) instead of also asserting rpk behavior, and avoid claiming kafka_batch_max_bytes is unconfigurable via any Cloud interface pending confirmation of Console behavior. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Feediver1
left a comment
Feediver1
left a comment
There was a problem hiding this comment.
Final-pass review (docs-team-standards)
Overall: Accurate, well-scoped fix for a real field-reported problem, with a good property-name correction. No critical issues — one technical-accuracy item to confirm (the Terraform attribute name).
Context: cluster-properties.adoc is generated (includes streaming:reference:partial$properties/cluster-properties.adoc filtered to redpanda-cloud tags), so the "allowlist" = properties tagged redpanda-cloud in the streaming component.
What this PR does
Clarifies that only allowlisted cluster properties are configurable in Redpanda Cloud (setting others returns REASON_INVALID_INPUT), adds Terraform + max-message-size sections, and corrects the topic property name to max.message.bytes. Field-report-driven (a BYOC customer hit the error setting kafka_batch_max_bytes via Terraform).
Critical issues
None. Verified:
- Both reference xrefs resolve (
cluster-properties.adoc,object-storage-properties.adocexist). <<max-message-size>>anchor resolves — defined once, referenced once.- Property-name correction is complete and consistent —
message.max.bytesandmax_message_bytesfully gone from cloud-docs;max.message.byteslands in all 4 spots. (Good catch:message.max.bytesis the broker name andmax_message_bytesisn't real;max.message.bytesis the correct topic property.) - No contradiction —
kafka_batch_max_bytesisn't listed in the Cloud reference, consistent with "not configurable."
Suggestions
- terraform-provider.adoc — verify. The provider attribute
custom_properties_json(withjsonencode({...})) is new to the docs and appears nowhere else; the Cloud API path usescustom_properties(a JSON object, per existing examples). Please confirmcustom_properties_jsonmatches the current Redpanda Terraform provider schema/version — a wrong attribute name here would produce the exactREASON_INVALID_INPUT-class failure the PR aims to prevent. (Likely correct — providers often expose a_jsonstring variant — but it's the one unverifiable claim.) - config-cluster.adoc:22 — minor. The allowlist-rejection wording scopes to "the Cloud API or the Terraform provider," but the "Set cluster configuration properties" section lists rpk as a set-path, so a reader using rpk with a non-allowlisted property isn't told what happens. Deliberate softening (commit 2, pending rpk/Console confirmation) — fine to leave; consider adding "rpk behaves the same" once confirmed.
Impact on other files
- Cross-repo (docs): the same wrong topic-property name (
message.max.bytes/max_message_bytes) may exist in the self-managed docs repo's topic/reference pages. cloud-docs is fully corrected here; worth a quick check indocs. - No nav change; no new What's New entry needed — the PR correctly fixes the name in the existing What's New entry.
CodeRabbit
No CodeRabbit or human reviews posted yet.
What works well
- Fixes a genuine technical error (broker-vs-topic property name) consistently across all four files — no stragglers.
- Root-cause accurate — frames the allowlist as control-plane behavior and points to the right topic-level property.
- Sensible claim-scoping (commit 2) — narrowed the
REASON_INVALID_INPUTclaim to evidenced paths (API/Terraform) rather than over-asserting rpk/Console. - Reuses the established
audit_enabledexample and cross-links config-cluster / terraform / create-topic cleanly.
🤖 Automated final-pass review via docs-team-standards pr-review.
2 participants
What
Clarifies which cluster configuration properties can be set in Redpanda Cloud (via
rpk, the Cloud API, or the Terraform provider), and redirects users to the topic-level property for controlling maximum message size.Prompted by a customer/field report: a BYOC user tried to set
kafka_batch_max_bytesthrough the Terraform provider and hitREASON_INVALID_INPUT ... The properties [kafka_batch_max_bytes] are not allowed. The provider passes the property through correctly; the Cloud control-plane API rejects it because only an allowlisted subset of properties is accepted incluster_configuration.custom_properties. The docs didn't state this, and the AI assistant recommended a cluster property that Cloud doesn't accept.Changes
manage/cluster-maintenance/config-cluster.adocREASON_INVALID_INPUT.max.message.bytes;kafka_batch_max_bytesis not configurable in Cloud.manage/terraform-provider.adoccluster_configuration { custom_properties_json = jsonencode({...}) }syntax, the allowlist caveat, and thekafka_batch_max_bytesexample, plus a Serverless/Azure note.develop/topics/create-topic.adocandget-started/whats-new-cloud.adocmax.message.bytes(wasmessage.max.bytes/max_message_bytes).Notes for reviewers
max.message.bytesthe only path? These edits state the topic-level path, which is accurate today.🤖 Generated with Claude Code
Preview pages