fix(DOC-1711): clarify rps_limit_* cluster property descriptions#1620
Open
fix(DOC-1711): clarify rps_limit_* cluster property descriptions#1620
Conversation
Add overrides for all five rps_limit_* cluster properties to clarify: - "rps" means requests per second (not just "rate") - "controller" refers to cluster management operations processed through the controller log (raft0), not produce/consume operations Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThis PR adds five new rate-limit properties to the documentation configuration and updates descriptive metadata. Five new cluster-scoped properties are introduced: Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
modules/reference/attachments/redpanda-properties-v25.3.10.json (1)
12102-12174:⚠️ Potential issue | 🟡 MinorAdd an explicit “not produce/consume” sentence to each
rps_limit_*description.On Line 12102, Line 12120, Line 12138, Line 12156, and Line 12174, the text implies controller-only management traffic, but it still does not explicitly state that produce/consume requests are excluded.
✏️ Proposed wording update
- "description": "Rate limit, in requests per second, for ACL and user operations on the controller. The controller processes cluster management requests (such as creating, deleting, and updating ACLs and users) through the controller log (raft0).", + "description": "Rate limit, in requests per second, for ACL and user operations on the controller. The controller processes cluster management requests (such as creating, deleting, and updating ACLs and users) through the controller log (raft0). This limit does not apply to produce or consume requests.", - "description": "Rate limit, in requests per second, for configuration operations on the controller. The controller processes cluster management requests (such as cluster configuration updates, feature activations, and data policy changes) through the controller log (raft0).", + "description": "Rate limit, in requests per second, for configuration operations on the controller. The controller processes cluster management requests (such as cluster configuration updates, feature activations, and data policy changes) through the controller log (raft0). This limit does not apply to produce or consume requests.", - "description": "Rate limit, in requests per second, for move operations on the controller. The controller processes cluster management requests (such as moving and canceling partition replica reassignments) through the controller log (raft0).", + "description": "Rate limit, in requests per second, for move operations on the controller. The controller processes cluster management requests (such as moving and canceling partition replica reassignments) through the controller log (raft0). This limit does not apply to produce or consume requests.", - "description": "Rate limit, in requests per second, for node management operations on the controller. The controller processes cluster management requests (such as decommissioning, recommissioning, and setting brokers to maintenance mode) through the controller log (raft0).", + "description": "Rate limit, in requests per second, for node management operations on the controller. The controller processes cluster management requests (such as decommissioning, recommissioning, and setting brokers to maintenance mode) through the controller log (raft0). This limit does not apply to produce or consume requests.", - "description": "Rate limit, in requests per second, for topic operations on the controller. The controller processes cluster management requests (such as creating, deleting, and updating topics and partition counts) through the controller log (raft0).", + "description": "Rate limit, in requests per second, for topic operations on the controller. The controller processes cluster management requests (such as creating, deleting, and updating topics and partition counts) through the controller log (raft0). This limit does not apply to produce or consume requests.",🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/reference/attachments/redpanda-properties-v25.3.10.json` around lines 12102 - 12174, Each rps_limit_* controller setting (rps_limit_acls_and_users_operations, rps_limit_configuration_operations, rps_limit_move_operations, rps_limit_node_management_operations, rps_limit_topic_operations) needs an explicit sentence appended to its "description" stating that these limits apply only to controller management requests and do not apply to client produce/consume traffic; update each description to add a short sentence like: "This limit applies only to controller management requests processed via the controller log (raft0) and does not apply to client produce or consume requests." to make the exclusion explicit.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs-data/property-overrides.json`:
- Around line 3-22: Update the descriptions for
rps_limit_acls_and_users_operations, rps_limit_configuration_operations,
rps_limit_move_operations, rps_limit_node_management_operations, and
rps_limit_topic_operations to explicitly state that these rate limits apply only
to controller operations and do not apply to produce or consume (client data)
traffic as requested in DOC-1711; add a clear sentence such as "These limits
apply only to controller operations and do not apply to produce or consume
traffic." to each property's description to remove ambiguity.
---
Outside diff comments:
In `@modules/reference/attachments/redpanda-properties-v25.3.10.json`:
- Around line 12102-12174: Each rps_limit_* controller setting
(rps_limit_acls_and_users_operations, rps_limit_configuration_operations,
rps_limit_move_operations, rps_limit_node_management_operations,
rps_limit_topic_operations) needs an explicit sentence appended to its
"description" stating that these limits apply only to controller management
requests and do not apply to client produce/consume traffic; update each
description to add a short sentence like: "This limit applies only to controller
management requests processed via the controller log (raft0) and does not apply
to client produce or consume requests." to make the exclusion explicit.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 38eaaa63-82f1-4c23-8b7f-ae2b8e6d60d1
📒 Files selected for processing (2)
docs-data/property-overrides.jsonmodules/reference/attachments/redpanda-properties-v25.3.10.json
Comment on lines
+3
to
+22
| "rps_limit_acls_and_users_operations": { | ||
| "description": "Rate limit, in requests per second, for ACL and user operations on the controller. The controller processes cluster management requests (such as creating, deleting, and updating ACLs and users) through the controller log (raft0).", | ||
| "config_scope": "cluster" | ||
| }, | ||
| "rps_limit_configuration_operations": { | ||
| "description": "Rate limit, in requests per second, for configuration operations on the controller. The controller processes cluster management requests (such as cluster configuration updates, feature activations, and data policy changes) through the controller log (raft0).", | ||
| "config_scope": "cluster" | ||
| }, | ||
| "rps_limit_move_operations": { | ||
| "description": "Rate limit, in requests per second, for move operations on the controller. The controller processes cluster management requests (such as moving and canceling partition replica reassignments) through the controller log (raft0).", | ||
| "config_scope": "cluster" | ||
| }, | ||
| "rps_limit_node_management_operations": { | ||
| "description": "Rate limit, in requests per second, for node management operations on the controller. The controller processes cluster management requests (such as decommissioning, recommissioning, and setting brokers to maintenance mode) through the controller log (raft0).", | ||
| "config_scope": "cluster" | ||
| }, | ||
| "rps_limit_topic_operations": { | ||
| "description": "Rate limit, in requests per second, for topic operations on the controller. The controller processes cluster management requests (such as creating, deleting, and updating topics and partition counts) through the controller log (raft0).", | ||
| "config_scope": "cluster" | ||
| }, |
Contributor
There was a problem hiding this comment.
Make the exclusion explicit: these limits do not apply to produce/consume traffic.
The new descriptions imply controller-only scope, but they don’t explicitly state the “not produce or consume” boundary requested in DOC-1711. Please add that sentence to each rps_limit_* description to remove ambiguity.
✏️ Proposed wording update
"rps_limit_acls_and_users_operations": {
- "description": "Rate limit, in requests per second, for ACL and user operations on the controller. The controller processes cluster management requests (such as creating, deleting, and updating ACLs and users) through the controller log (raft0).",
+ "description": "Rate limit, in requests per second, for ACL and user operations on the controller. The controller processes cluster management requests (such as creating, deleting, and updating ACLs and users) through the controller log (raft0). This limit does not apply to produce or consume operations.",
"config_scope": "cluster"
},
"rps_limit_configuration_operations": {
- "description": "Rate limit, in requests per second, for configuration operations on the controller. The controller processes cluster management requests (such as cluster configuration updates, feature activations, and data policy changes) through the controller log (raft0).",
+ "description": "Rate limit, in requests per second, for configuration operations on the controller. The controller processes cluster management requests (such as cluster configuration updates, feature activations, and data policy changes) through the controller log (raft0). This limit does not apply to produce or consume operations.",
"config_scope": "cluster"
},
"rps_limit_move_operations": {
- "description": "Rate limit, in requests per second, for move operations on the controller. The controller processes cluster management requests (such as moving and canceling partition replica reassignments) through the controller log (raft0).",
+ "description": "Rate limit, in requests per second, for move operations on the controller. The controller processes cluster management requests (such as moving and canceling partition replica reassignments) through the controller log (raft0). This limit does not apply to produce or consume operations.",
"config_scope": "cluster"
},
"rps_limit_node_management_operations": {
- "description": "Rate limit, in requests per second, for node management operations on the controller. The controller processes cluster management requests (such as decommissioning, recommissioning, and setting brokers to maintenance mode) through the controller log (raft0).",
+ "description": "Rate limit, in requests per second, for node management operations on the controller. The controller processes cluster management requests (such as decommissioning, recommissioning, and setting brokers to maintenance mode) through the controller log (raft0). This limit does not apply to produce or consume operations.",
"config_scope": "cluster"
},
"rps_limit_topic_operations": {
- "description": "Rate limit, in requests per second, for topic operations on the controller. The controller processes cluster management requests (such as creating, deleting, and updating topics and partition counts) through the controller log (raft0).",
+ "description": "Rate limit, in requests per second, for topic operations on the controller. The controller processes cluster management requests (such as creating, deleting, and updating topics and partition counts) through the controller log (raft0). This limit does not apply to produce or consume operations.",
"config_scope": "cluster"
},🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs-data/property-overrides.json` around lines 3 - 22, Update the
descriptions for rps_limit_acls_and_users_operations,
rps_limit_configuration_operations, rps_limit_move_operations,
rps_limit_node_management_operations, and rps_limit_topic_operations to
explicitly state that these rate limits apply only to controller operations and
do not apply to produce or consume (client data) traffic as requested in
DOC-1711; add a clear sentence such as "These limits apply only to controller
operations and do not apply to produce or consume traffic." to each property's
description to remove ambiguity.
kbatuigas
approved these changes
Mar 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
property-overrides.jsonentries for all fiverps_limit_*cluster properties to clarify two gaps identified in DOC-1711:Affected properties:
rps_limit_acls_and_users_operationsrps_limit_configuration_operationsrps_limit_move_operationsrps_limit_node_management_operationsrps_limit_topic_operationsTest plan
🤖 Generated with Claude Code