Skip to content

Commit e43efaa

Browse files
Feediver1claude
andauthored
DOC-2237: correct decommission + maintenance mode guidance (v/25.2 backport) (#1737)
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent fdc7fe4 commit e43efaa

5 files changed

Lines changed: 12 additions & 4 deletions

File tree

local-antora-playbook.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,17 @@ content:
1515
- url: .
1616
branches: HEAD
1717
- url: https://github.com/redpanda-data/docs
18-
branches: [v/*, shared, site-search,'!v-end-of-life/*']
18+
branches: [main, v/*, '!v/25.2', shared, site-search,'!v-end-of-life/*']
1919
- url: https://github.com/redpanda-data/cloud-docs
2020
branches: 'main'
2121
- url: https://github.com/redpanda-data/redpanda-labs
2222
branches: main
2323
start_paths: [docs,'*/docs']
2424
- url: https://github.com/redpanda-data/rp-connect-docs
2525
branches: main
26+
- url: https://github.com/redpanda-data/docs-site
27+
branches: main
28+
start_paths: [home, data-platform, self-managed]
2629
ui:
2730
bundle:
2831
url: https://github.com/redpanda-data/docs-ui/releases/latest/download/ui-bundle.zip

modules/manage/pages/cluster-maintenance/decommission-brokers.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ When you decommission a broker, its partition replicas are reallocated across th
1010
1111
CAUTION: When a broker is decommissioned, it cannot rejoin the cluster. If a broker with the same ID tries to rejoin the cluster, it is rejected.
1212

13+
NOTE: Entering xref:manage:node-management.adoc[maintenance mode] before decommissioning is optional. Decommissioning drains partition leadership gracefully on its own.
14+
1315
== What happens when a broker is decommissioned?
1416

1517
When a broker is decommissioned, the controller leader creates a reallocation plan for all partition replicas that are allocated to that broker. By default, this reallocation is done in batches of 50 to avoid overwhelming the remaining brokers with Raft recovery. See xref:reference:tunable-properties.adoc#partition_autobalancing_concurrent_moves[`partition_autobalancing_concurrent_moves`].

modules/manage/pages/kubernetes/k-decommission-brokers.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ You may want to decommission a broker in the following situations:
1515
1616
NOTE: When a broker is decommissioned, it cannot rejoin the cluster. If a broker with the same ID tries to rejoin the cluster, it is rejected.
1717

18+
NOTE: Entering xref:manage:node-management.adoc[maintenance mode] before decommissioning is optional. Decommissioning drains partition leadership gracefully on its own.
19+
1820
== Prerequisites
1921

2022
You must have the following:

modules/manage/pages/node-management.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
Maintenance mode lets you take a Redpanda broker offline temporarily while minimizing disruption to client operations. When a broker is in maintenance mode, you can safely perform operations that require the Redpanda process to be temporarily stopped; for example, system maintenance or a xref:manage:cluster-maintenance/rolling-upgrade.adoc[rolling upgrade].
88

9-
CAUTION: A broker cannot be decommissioned while it's in maintenance mode. Take the broker out of maintenance mode first by running `rpk cluster maintenance disable <node-id>`.
9+
// DOC-2237: from 24.1.15 / 24.2.1 onward, decommission gracefully drains leadership, so maintenance mode beforehand is optional. Kept the prior CAUTION block accurate to behavior, not pre-22.x semantics.
10+
NOTE: Putting a broker into maintenance mode before decommissioning is optional. Decommissioning gracefully drains partition leadership on its own, so you can decommission a broker directly without first entering maintenance mode.
1011

1112
When a broker is placed in maintenance mode, if the replication factor is greater than one, it reassigns partition leadership to other brokers in the cluster. The broker is not eligible for partition leadership again until it is taken out of maintenance mode.
1213

modules/upgrade/partials/rolling-upgrades/enable-maintenance-mode.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,10 @@ The combination of the `--watch` and `--exit-when-healthy` flags tell rpk to mon
102102
[NOTE]
103103
====
104104
ifdef::rolling-upgrade[]
105-
You can also evaluate xref:manage:monitoring.adoc[metrics] to determine cluster health. If the cluster has any issues, take the broker out of maintenance mode by running the following command before proceeding with other operations, such as decommissioning or retrying the rolling upgrade:
105+
You can also evaluate xref:manage:monitoring.adoc[metrics] to determine cluster health. If the cluster has any issues, take the broker out of maintenance mode by running the following command before retrying the rolling upgrade:
106106
endif::[]
107107
ifdef::rolling-restart[]
108-
You can also evaluate xref:manage:monitoring.adoc[metrics] to determine cluster health. If the cluster has any issues, take the broker out of maintenance mode by running the following command before proceeding with other operations, such as decommissioning or retrying the rolling restart:
108+
You can also evaluate xref:manage:monitoring.adoc[metrics] to determine cluster health. If the cluster has any issues, take the broker out of maintenance mode by running the following command before retrying the rolling restart:
109109
endif::[]
110110

111111
```bash

0 commit comments

Comments
 (0)