[DOCS] Add remote node as a node role (#62730) (#62776)

* Adding remote node as a node role.

* Incorporating reviewer feedback.
This commit is contained in:
Adam Locke 2020-09-22 12:02:22 -04:00 committed by GitHub
parent 7e97f17845
commit 56fbfabeda
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 49 additions and 25 deletions

View File

@ -27,9 +27,14 @@ dedicated data nodes, {ml} nodes, and {transform} nodes.
You can define the roles of a node by setting `node.roles`. If you don't
configure this setting, then the node has the following roles by default:
`master`, `data`, `ingest`, `ml`.
If you set node.roles, the node is assigned only the roles you specify.
* `master`
* `data`
* `ingest`
* `ml`
* `remote_cluster_client`
NOTE: If you set `node.roles`, the node is assigned only the roles you specify.
<<master-node,Master-eligible node>>::
@ -49,6 +54,12 @@ document before indexing. With a heavy ingest load, it makes sense to use
dedicated ingest nodes and to not include the `ingest` role from nodes that have
the `master` or `data` roles.
<<remote-node,Remote-eligible node>>::
A node that has the `remote_cluster_client` role (default), which makes it
eligible to act as a remote client. By default, any node in the cluster can act
as a cross-cluster client and connect to remote clusters.
<<ml-node,Machine learning node>>::
A node that has `xpack.ml.enabled` and the `ml` role, which is the default
@ -191,9 +202,9 @@ and data roles.
To create a dedicated data node, set:
[source,yaml]
-------------------
----
node.roles: [ data ]
-------------------
----
[[node-ingest-node]]
==== Ingest node
@ -206,9 +217,9 @@ ingest nodes, that will only perform this specific task.
To create a dedicated ingest node, set:
[source,yaml]
-------------------
----
node.roles: [ ingest ]
-------------------
----
[[node-ingest-node-setting]]
// tag::node-ingest-tag[]
@ -241,9 +252,22 @@ serve the same purpose.
To create a dedicated coordinating node, set:
[source,yaml]
-------------------
----
node.roles: [ ]
-------------------
----
[[remote-node]]
==== Remote-eligible node
By default, any node in a cluster can act as a cross-cluster client and connect
to <<modules-remote-clusters,remote clusters>>. Once connected, you can search
remote clusters using <<modules-cross-cluster-search,{ccs}>>. You can also sync
data between clusters using <<xpack-ccr,{ccr}>>.
[source,yaml]
----
node.roles: [ remote_cluster_client ]
----
[[ml-node]]
==== [xpack]#Machine learning node#
@ -262,10 +286,10 @@ For more information about these settings, see <<ml-settings>>.
To create a dedicated {ml} node in the {default-dist}, set:
[source,yaml]
-------------------
----
node.roles: [ ml ]
xpack.ml.enabled: true <1>
-------------------
----
<1> The `xpack.ml.enabled` setting is enabled by default.
[[transform-node]]
@ -278,9 +302,9 @@ you have the {oss-dist}, do not use these settings. For more information, see
To create a dedicated {transform} node in the {default-dist}, set:
[source,yaml]
-------------------
----
node.roles: [ transform ]
-------------------
----
[[change-node-role]]
==== Changing the role of a node
@ -336,16 +360,16 @@ to `$ES_HOME/data` but can be configured in the `elasticsearch.yml` config
file an absolute path or a path relative to `$ES_HOME` as follows:
[source,yaml]
-----------------------
----
path.data: /var/elasticsearch/data
-----------------------
----
Like all node settings, it can also be specified on the command line as:
[source,sh]
-----------------------
----
./bin/elasticsearch -Epath.data=/var/elasticsearch/data
-----------------------
----
TIP: When using the `.zip` or `.tar.gz` distributions, the `path.data` setting
should be configured to locate the data directory outside the {es} home