honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify voting-only master node docs (#43857) 

Clarifies the roles of a dedicated voting-only master-eligible node.

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
Co-Authored-By: David Turner <david.turner@elastic.co>
This commit is contained in:
Yannick Welsch 2019-07-02 18:48:29 +02:00
parent 697cd494bf
commit cc7c5ab2c0
1 changed files with 78 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
docs/reference/modules/node.asciidoc
View File

@ -109,18 +109,20 @@ To create a dedicated master-eligible node in the {default-dist}, set:
[source,yaml] [source,yaml]
------------------- -------------------
node.master: true <1> node.master: true <1>
node.data: false <2> node.voting_only: false <2>
node.ingest: false <3> node.data: false <3>
node.ml: false <4> node.ingest: false <4>
xpack.ml.enabled: true <5> node.ml: false <5>
cluster.remote.connect: false <6> xpack.ml.enabled: true <6>
cluster.remote.connect: false <7>
------------------- -------------------
<1> The `node.master` role is enabled by default. <1> The `node.master` role is enabled by default.
<2> Disable the `node.data` role (enabled by default). <2> The `node.voting_only` role is disabled by default.
<3> Disable the `node.ingest` role (enabled by default). <3> Disable the `node.data` role (enabled by default).
<4> Disable the `node.ml` role (enabled by default). <4> Disable the `node.ingest` role (enabled by default).
<5> The `xpack.ml.enabled` setting is enabled by default. <5> Disable the `node.ml` role (enabled by default).
<6> Disable {ccs} (enabled by default). <6> The `xpack.ml.enabled` setting is enabled by default.
<7> Disable {ccs} (enabled by default).
To create a dedicated master-eligible node in the {oss-dist}, set: To create a dedicated master-eligible node in the {oss-dist}, set:
@ -177,6 +179,30 @@ reasonably fast persistent storage and a reliable and low-latency network
connection to the rest of the cluster, since they are on the critical path for connection to the rest of the cluster, since they are on the critical path for
<<cluster-state-publishing,publishing cluster state updates>>. <<cluster-state-publishing,publishing cluster state updates>>.
Voting-only master-eligible nodes may also fill other roles in your cluster.
For instance, a node may be both a data node and a voting-only master-eligible
node. A _dedicated_ voting-only master-eligible nodes is a voting-only
master-eligible node that fills no other roles in the cluster. To create a
dedicated voting-only master-eligible node in the {default-dist}, set:
[source,yaml]
-------------------
node.master: true <1>
node.voting_only: true <2>
node.data: false <3>
node.ingest: false <4>
node.ml: false <5>
xpack.ml.enabled: true <6>
cluster.remote.connect: false <7>
-------------------
<1> The `node.master` role is enabled by default.
<2> Enable the `node.voting_only` role (disabled by default).
<3> Disable the `node.data` role (enabled by default).
<4> Disable the `node.ingest` role (enabled by default).
<5> Disable the `node.ml` role (enabled by default).
<6> The `xpack.ml.enabled` setting is enabled by default.
<7> Disable {ccs} (enabled by default).
[float] [float]
[[data-node]] [[data-node]]
=== Data Node === Data Node
@ -193,16 +219,18 @@ To create a dedicated data node in the {default-dist}, set:
[source,yaml] [source,yaml]
------------------- -------------------
node.master: false <1> node.master: false <1>
node.data: true <2> node.voting_only: false <2>
node.ingest: false <3> node.data: true <3>
node.ml: false <4> node.ingest: false <4>
cluster.remote.connect: false <5> node.ml: false <5>
cluster.remote.connect: false <6>
------------------- -------------------
<1> Disable the `node.master` role (enabled by default). <1> Disable the `node.master` role (enabled by default).
<2> The `node.data` role is enabled by default. <2> The `node.voting_only` role is disabled by default.
<3> Disable the `node.ingest` role (enabled by default). <3> The `node.data` role is enabled by default.
<4> Disable the `node.ml` role (enabled by default). <4> Disable the `node.ingest` role (enabled by default).
<5> Disable {ccs} (enabled by default). <5> Disable the `node.ml` role (enabled by default).
<6> Disable {ccs} (enabled by default).
To create a dedicated data node in the {oss-dist}, set: To create a dedicated data node in the {oss-dist}, set:
[source,yaml] [source,yaml]
@ -231,16 +259,18 @@ To create a dedicated ingest node in the {default-dist}, set:
[source,yaml] [source,yaml]
------------------- -------------------
node.master: false <1> node.master: false <1>
node.data: false <2> node.voting_only: false <2>
node.ingest: true <3> node.data: false <3>
node.ml: false <4> node.ingest: true <4>
cluster.remote.connect: false <5> node.ml: false <5>
cluster.remote.connect: false <6>
------------------- -------------------
<1> Disable the `node.master` role (enabled by default). <1> Disable the `node.master` role (enabled by default).
<2> Disable the `node.data` role (enabled by default). <2> The `node.voting_only` role is disabled by default.
<3> The `node.ingest` role is enabled by default. <3> Disable the `node.data` role (enabled by default).
<4> Disable the `node.ml` role (enabled by default). <4> The `node.ingest` role is enabled by default.
<5> Disable {ccs} (enabled by default). <5> Disable the `node.ml` role (enabled by default).
<6> Disable {ccs} (enabled by default).
To create a dedicated ingest node in the {oss-dist}, set: To create a dedicated ingest node in the {oss-dist}, set:
@ -282,16 +312,18 @@ To create a dedicated coordinating node in the {default-dist}, set:
[source,yaml] [source,yaml]
------------------- -------------------
node.master: false <1> node.master: false <1>
node.data: false <2> node.voting_only: false <2>
node.ingest: false <3> node.data: false <3>
node.ml: false <4> node.ingest: false <4>
cluster.remote.connect: false <5> node.ml: false <5>
cluster.remote.connect: false <6>
------------------- -------------------
<1> Disable the `node.master` role (enabled by default). <1> Disable the `node.master` role (enabled by default).
<2> Disable the `node.data` role (enabled by default). <2> The `node.voting_only` role is disabled by default.
<3> Disable the `node.ingest` role (enabled by default). <3> Disable the `node.data` role (enabled by default).
<4> Disable the `node.ml` role (enabled by default). <4> Disable the `node.ingest` role (enabled by default).
<5> Disable {ccs} (enabled by default). <5> Disable the `node.ml` role (enabled by default).
<6> Disable {ccs} (enabled by default).
To create a dedicated coordinating node in the {oss-dist}, set: To create a dedicated coordinating node in the {oss-dist}, set:
@ -326,18 +358,20 @@ To create a dedicated {ml} node in the {default-dist}, set:
[source,yaml] [source,yaml]
------------------- -------------------
node.master: false <1> node.master: false <1>
node.data: false <2> node.voting_only: false <2>
node.ingest: false <3> node.data: false <3>
node.ml: true <4> node.ingest: false <4>
xpack.ml.enabled: true <5> node.ml: true <5>
cluster.remote.connect: false <6> xpack.ml.enabled: true <6>
cluster.remote.connect: false <7>
------------------- -------------------
<1> Disable the `node.master` role (enabled by default). <1> Disable the `node.master` role (enabled by default).
<2> Disable the `node.data` role (enabled by default). <2> The `node.voting_only` role is disabled by default.
<3> Disable the `node.ingest` role (enabled by default). <3> Disable the `node.data` role (enabled by default).
<4> The `node.ml` role is enabled by default. <4> Disable the `node.ingest` role (enabled by default).
<5> The `xpack.ml.enabled` setting is enabled by default. <5> The `node.ml` role is enabled by default.
<6> Disable {ccs} (enabled by default). <6> The `xpack.ml.enabled` setting is enabled by default.
<7> Disable {ccs} (enabled by default).
[float] [float]
[[change-node-role]] [[change-node-role]]