Skip to content

Commit

Permalink
Fix wording on node roles
Browse files Browse the repository at this point in the history
In the 8.17 docs there is a statement that intends to say that
nodes without roles are coordinating-only nodes. However, the wording
was misleading because it referred to  leaving the setting _unset_
rather than explictly setting it to _empty_.
  • Loading branch information
tvernum committed Mar 3, 2025
1 parent 250b431 commit 11bd798
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/reference/modules/node.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ The following additional roles are available:

* `voting_only`

[[coordinating-only-node]]If you leave `node.roles` unset, then the node is considered to be a <<coordinating-only-node-role,coordinating only node>>.
[[coordinating-only-node]]If you set `node.roles` to an empty array (`node.roles: [ ]`),
then the node is considered to be a <<coordinating-only-node-role,coordinating only node>>.

[IMPORTANT]
====
Expand Down Expand Up @@ -155,4 +156,4 @@ including:

* <<cluster-name,`cluster.name`>>
* <<node-name,`node.name`>>
* <<modules-network,network settings>>
* <<modules-network,network settings>>

0 comments on commit 11bd798

Please sign in to comment.