Skip to content

Commit 586f361

Browse files
Feediver1claude
andauthored
DOC-2237: correct decommission + maintenance mode guidance (v/24.1 backport) (#1741)
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 118215e commit 586f361

5 files changed

Lines changed: 10 additions & 3 deletions

File tree

local-antora-playbook.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ content:
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
@@ -11,6 +11,8 @@ When you decommission a broker, its partition replicas are reallocated across th
1111
1212
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.
1313

14+
NOTE: Entering xref:manage:node-management.adoc[maintenance mode] before decommissioning is recommended but not required. Maintenance mode reassigns partition leadership up front, which can be smoother for clients than draining leadership during decommissioning.
15+
1416
== What happens when a broker is decommissioned?
1517

1618
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
@@ -14,6 +14,8 @@ When you decommission a broker, its partition replicas are reallocated across th
1414
1515
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.
1616

17+
NOTE: Entering xref:manage:node-management.adoc[maintenance mode] before decommissioning is recommended but not required. Maintenance mode reassigns partition leadership up front, which can be smoother for clients than draining leadership during decommissioning.
18+
1719
== Prerequisites
1820

1921
You must have the following:

modules/manage/pages/node-management.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
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+
NOTE: Putting a broker into maintenance mode before decommissioning is recommended but not required. Maintenance mode reassigns partition leadership up front, which can be smoother for clients than draining leadership during decommissioning.
1010

1111
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.
1212

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ The combination of the `--watch` and `--exit-when-healthy` flags tell rpk to mon
7474
[NOTE]
7575
====
7676
ifdef::rolling-upgrade[]
77-
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:
77+
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:
7878
endif::[]
7979
ifdef::rolling-restart[]
80-
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:
80+
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:
8181
endif::[]
8282

8383
```bash

0 commit comments

Comments
 (0)