Skip to content

Commit c38c6d9

Browse files
JakeSCahillFeediver1
authored andcommitted
DOC-834 Warn users to never assign broker IDs (#910)
Co-authored-by: Joyce Fee <[email protected]> (cherry picked from commit 281c1ab)
1 parent 06e36e6 commit c38c6d9

File tree

3 files changed

+24
-6
lines changed

3 files changed

+24
-6
lines changed

modules/deploy/pages/deployment-option/self-hosted/manual/production/production-deployment.adoc

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -212,13 +212,20 @@ IMPORTANT: Redpanda expects its storage to be persistent, and it's an error
212212
to erase a broker's drive and restart it. However, in some environments (like when migrating to a different Node pool on Kubernetes), truly persistent storage is unavailable,
213213
and brokers may find their data volumes erased. For such environments, Redpanda recommends setting `empty_seed_starts_cluster` to false and designating a set of seed servers such that they couldn't lose their storage simultaneously.
214214

215-
=== Configure broker IDs
215+
=== Do not configure broker IDs
216216

217-
Redpanda automatically generates unique IDs for each new broker. This means that you don't need to include IDs in configuration files or worry about policies on `node_id` re-use.
217+
Redpanda automatically generates unique broker IDs for each new broker and assigns it to the xref:reference:properties/broker-properties.adoc[`node_id`] field in the broker configuration. This ensures safe and consistent cluster operations without requiring manual configuration.
218218

219-
If you choose to assign broker IDs, make sure to use a fresh `node_id` each time you add a broker to the cluster.
219+
.Do not set `node_id` manually.
220+
[WARNING]
221+
====
222+
Redpanda assigns unique IDs automatically to prevent issues such as:
223+
224+
- Brokers with empty disks rejoining the cluster.
225+
- Conflicts during recovery or scaling.
220226
221-
CAUTION: Never reuse broker IDs, even for brokers that have been decommissioned and restarted empty. Doing so can result in an inconsistent state.
227+
Manually setting or reusing `node_id` values, even for decommissioned brokers, can cause cluster inconsistencies and operational failures.
228+
====
222229

223230
include::deploy:partial$self-test.adoc[leveloffset=+1]
224231

modules/manage/pages/cluster-maintenance/node-property-configuration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The default `redpanda.yaml` file groups broker properties into categories:
1616

1717
The `redpanda.yaml` file rarely needs to be edited after the system is installed, but you can choose to change broker configuration property values.
1818

19-
CAUTION: The one broker configuration property you cannot change is the unique broker identifier: `node_id`. After a broker joins the cluster, do not change the `node_id`. You can altogether omit `node_id` from `redpanda.yaml` and have Redpanda assign it automatically. For more information, see xref:deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc#configure-broker-ids[Configure broker IDs].
19+
NOTE: The broker configuration property xref:reference:properties/broker-properties.adoc[`node_id`] is immutable. To ensure safe operations, omit the `node_id` field from `redpanda.yaml` and allow Redpanda to assign it automatically. For more information, see xref:deploy:deployment-option/self-hosted/manual/production/production-deployment.adoc#do-not-configure-broker-ids[Do not configure broker IDs].
2020

2121
To change a broker property setting:
2222

modules/reference/pages/properties/broker-properties.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,18 @@ Threshold for log messages that contain a larger memory allocation than specifie
201201

202202
A number that uniquely identifies the broker within the cluster. If `null` (the default value), Redpanda automatically assigns an ID. If set, it must be non-negative value.
203203

204-
CAUTION: The `node_id` property must not be changed after a broker joins the cluster.
204+
.Do not set `node_id` manually.
205+
[WARNING]
206+
====
207+
Redpanda assigns unique IDs automatically to prevent issues such as:
208+
209+
- Brokers with empty disks rejoining the cluster.
210+
- Conflicts during recovery or scaling.
211+
212+
Manually setting or reusing `node_id` values, even for decommissioned brokers, can cause cluster inconsistencies and operational failures.
213+
====
214+
215+
Broker IDs are immutable. After a broker joins the cluster, its `node_id` *cannot* be changed.
205216

206217

207218
*Accepted values:* [`0`, `4294967295`]

0 commit comments

Comments
 (0)