Skip to content

Commit ef6d49d

Browse files
Expand #2177 to both 4.1 and 4.0 guide versions; edits
1 parent e7dd605 commit ef6d49d

File tree

2 files changed

+52
-5
lines changed

2 files changed

+52
-5
lines changed

docs/cluster-formation.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,16 @@ so nodes don't have to (or cannot) explicitly register. However, the list of clu
124124
is not predefined. Such backends usually include a no-op registration step
125125
and apply one of the [race condition mitigation mechanisms](#initial-formation-race-condition) described below.
126126

127-
When the configured backend supports registration, nodes unregister when they stop. It is
128-
possible to opt-out of registration with the config option `cluster_formation.registration = false`.
129-
In such cases, the node has to be registered manually or using another mechanism, e.g. with container
130-
orchestrators like Nomad or Kubernetes.
127+
If the configured backend supports registration, nodes unregister when they are instructed to stop.
128+
129+
It is possible to opt-out of registration completely with the config option `cluster_formation.registration.enabled`:
130+
131+
```ini
132+
cluster_formation.registration.enabled = false
133+
```
134+
135+
When configured this way, the node has to be registered manually or using another mechanism,
136+
e.g. by a container orchestrator such as [Nomad](https://developer.hashicorp.com/nomad/integrations/hashicorp/rabbitmq) or [Kubernetes](https://www.rabbitmq.com/kubernetes/operator/operator-overview).
131137

132138
If peer discovery isn't configured, or it [repeatedly fails](#discovery-retries),
133139
or no peers are reachable, a node that wasn't a cluster member in the past
@@ -977,6 +983,22 @@ cluster_formation.consul.svc_ttl = 30
977983
cluster_formation.consul.include_nodes_with_warnings = true
978984
```
979985

986+
#### Opting Out of Regisration
987+
988+
If the configured backend supports registration,
989+
nodes unregister when they are instructed to stop.
990+
991+
It is possible to opt-out of registration completely with the config option
992+
`cluster_formation.registration.enabled`:
993+
994+
```ini
995+
cluster_formation.registration.enabled = false
996+
```
997+
998+
When configured this way, the node has to be registered manually or using another mechanism,
999+
e.g. by a container orchestrator such as [Nomad](https://developer.hashicorp.com/nomad/integrations/hashicorp/rabbitmq).
1000+
1001+
9801002
#### Node Name Suffixes
9811003

9821004
If node name is computed and long node names are used, it is possible to

versioned_docs/version-4.0/cluster-formation.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,16 @@ so nodes don't have to (or cannot) explicitly register. However, the list of clu
124124
is not predefined. Such backends usually include a no-op registration step
125125
and apply one of the [race condition mitigation mechanisms](#initial-formation-race-condition) described below.
126126

127-
When the configured backend supports registration, nodes unregister when they stop.
127+
If the configured backend supports registration, nodes unregister when they are instructed to stop.
128+
129+
It is possible to opt-out of registration completely with the config option `cluster_formation.registration.enabled`:
130+
131+
```ini
132+
cluster_formation.registration.enabled = false
133+
```
134+
135+
When configured this way, the node has to be registered manually or using another mechanism,
136+
e.g. by a container orchestrator such as [Nomad](https://developer.hashicorp.com/nomad/integrations/hashicorp/rabbitmq) or [Kubernetes](https://www.rabbitmq.com/kubernetes/operator/operator-overview).
128137

129138
If peer discovery isn't configured, or it [repeatedly fails](#discovery-retries),
130139
or no peers are reachable, a node that wasn't a cluster member in the past
@@ -974,6 +983,22 @@ cluster_formation.consul.svc_ttl = 30
974983
cluster_formation.consul.include_nodes_with_warnings = true
975984
```
976985

986+
#### Opting Out of Regisration
987+
988+
If the configured backend supports registration,
989+
nodes unregister when they are instructed to stop.
990+
991+
It is possible to opt-out of registration completely with the config option
992+
`cluster_formation.registration.enabled`:
993+
994+
```ini
995+
cluster_formation.registration.enabled = false
996+
```
997+
998+
When configured this way, the node has to be registered manually or using another mechanism,
999+
e.g. by a container orchestrator such as [Nomad](https://developer.hashicorp.com/nomad/integrations/hashicorp/rabbitmq).
1000+
1001+
9771002
#### Node Name Suffixes
9781003

9791004
If node name is computed and long node names are used, it is possible to

0 commit comments

Comments
 (0)