Skip to content

fix(DOC-1711): clarify rps_limit_* cluster property descriptions #1620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mfernest merged 1 commit into from
Mar 19, 2026
Merged

fix(DOC-1711): clarify rps_limit_* cluster property descriptions #1620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs-data/property-overrides.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
{
"properties": {
"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"
},
Comment on lines +3 to +22
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

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.

"abort_index_segment_size": {
"description": "Capacity (in number of txns) of an abort index segment.\n\nEach partition tracks the aborted transaction offset ranges to help service client requests. If the number of transactions increases beyond this threshold, they are flushed to disk to ease memory pressure. Then they're loaded on demand. This configuration controls the maximum number of aborted transactions before they are flushed to disk.",
"config_scope": "cluster"
Expand Down
11 changes: 6 additions & 5 deletions modules/reference/attachments/redpanda-properties-v25.3.10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12099,7 +12099,7 @@
"config_scope": "cluster",
"default": 1000,
"defined_in": "src/v/config/configuration.cc",
"description": "Rate limit for controller ACLs and user's 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).",
"is_deprecated": false,
"is_enterprise": false,
"name": "rps_limit_acls_and_users_operations",
Expand All @@ -12117,7 +12117,7 @@
"config_scope": "cluster",
"default": 1000,
"defined_in": "src/v/config/configuration.cc",
"description": "Rate limit for controller 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).",
"is_deprecated": false,
"is_enterprise": false,
"name": "rps_limit_configuration_operations",
Expand All @@ -12135,7 +12135,7 @@
"config_scope": "cluster",
"default": 1000,
"defined_in": "src/v/config/configuration.cc",
"description": "Rate limit for controller 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).",
"is_deprecated": false,
"is_enterprise": false,
"name": "rps_limit_move_operations",
Expand All @@ -12153,7 +12153,7 @@
"config_scope": "cluster",
"default": 1000,
"defined_in": "src/v/config/configuration.cc",
"description": "Rate limit for controller 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).",
"is_deprecated": false,
"is_enterprise": false,
"name": "rps_limit_node_management_operations",
Expand All @@ -12171,7 +12171,7 @@
"config_scope": "cluster",
"default": 1000,
"defined_in": "src/v/config/configuration.cc",
"description": "Rate limit for controller 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).",
"is_deprecated": false,
"is_enterprise": false,
"name": "rps_limit_topic_operations",
Expand Down Expand Up @@ -12462,6 +12462,7 @@
"needs_restart": false,
"nullable": false,
"type": "boolean",
"version": "v25.3.10",
"visibility": "tunable"
},
"schema_registry_enable_authorization": {
Expand Down
Loading