docs(DOC-732): document partition_autobalancing_node_autodecommission_time#1607
docs(DOC-732): document partition_autobalancing_node_autodecommission_time#1607
Conversation
…_time Add new cluster property that enables automatic decommission of unavailable nodes after a configurable timeout. Updates both the cluster properties reference and the continuous data balancing guide. 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. |
|
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:
📝 WalkthroughWalkthroughTwo documentation files were updated to introduce a new cluster property Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 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 Tip You can validate your CodeRabbit configuration file in your editor.If your editor has YAML language server, you can enable auto-completion and validation by adding |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
modules/manage/pages/cluster-maintenance/continuous-data-balancing.adoc (1)
30-30: Minor phrasing improvement (optional).The phrase "at least this timeout duration" is slightly awkward. Consider simplifying to "for this timeout duration" since the "at least" is implied by a timeout.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/manage/pages/cluster-maintenance/continuous-data-balancing.adoc` at line 30, Update the sentence describing the decommission timeout in continuous-data-balancing.adoc: replace the phrase "at least this timeout duration" with "for this timeout duration" to simplify phrasing; keep the rest of the sentence and references to the property partition_autobalancing_node_availability_timeout_sec unchanged so the meaning remains that a node unavailable for this timeout is permanently decommissioned.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@modules/manage/pages/cluster-maintenance/continuous-data-balancing.adoc`:
- Around line 29-34: The description for
partition_autobalancing_node_autodecommission_time is missing the unit and
prerequisite context: update the prose to state the unit is seconds (e.g.,
"measured in seconds") and add a sentence clarifying this property only applies
when partition_autobalancing_mode is set to continuous; also keep the existing
notes about default null/disabled, one-node-at-a-time behavior, and manual
intervention if decommission stalls so the table matches other properties'
phrasing and the PR objectives.
---
Nitpick comments:
In `@modules/manage/pages/cluster-maintenance/continuous-data-balancing.adoc`:
- Line 30: Update the sentence describing the decommission timeout in
continuous-data-balancing.adoc: replace the phrase "at least this timeout
duration" with "for this timeout duration" to simplify phrasing; keep the rest
of the sentence and references to the property
partition_autobalancing_node_availability_timeout_sec unchanged so the meaning
remains that a node unavailable for this timeout is permanently decommissioned.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2438c28d-c101-4515-b05e-1eacf4a7de5a
📒 Files selected for processing (2)
modules/manage/pages/cluster-maintenance/continuous-data-balancing.adocmodules/reference/partials/properties/cluster-properties.adoc
…roperty Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
| + | ||
| Default is 900 seconds (15 minutes). | ||
|
|
||
| | `partition_autobalancing_node_autodecommission_time` |
There was a problem hiding this comment.
partition_autobalancing_node_autodecommission_timeout_sec
This got updated down the line to reflect units
| | `partition_autobalancing_node_autodecommission_time` | ||
| | When a node is unavailable for this timeout duration (in seconds), Redpanda automatically and permanently decommissions the node. This property only applies when `partition_autobalancing_mode` is set to `continuous`. Unlike `partition_autobalancing_node_availability_timeout_sec`, which moves partitions while keeping the node in the cluster, this property removes the node from the cluster entirely. A decommissioned node cannot rejoin the cluster. + | ||
| + | ||
| Only one node is decommissioned at a time. If a decommission is already in progress, automatic decommission does not trigger until it completes. If the decommission stalls (for example, because the node holds the only replica of a partition), manual intervention is required. + |
There was a problem hiding this comment.
Might be worth cross-linking to node-wise recovery here
2 participants
Summary
Documents the new
partition_autobalancing_node_autodecommission_timecluster property introduced in PR #28946 (CORE-7111).partition_autobalancing_node_availability_timeout_secKey points documented:
partition_autobalancing_modeiscontinuousavailability_timeout_sec, the node cannot rejoinSME: Joe Miller
Preview
Test plan
🤖 Generated with Claude Code