1
1
[[modules-node]]
2
2
=== Node
3
3
4
- Any time that you start an instance of {es}, you are starting a _node_. A
4
+ Any time that you start an instance of {es}, you are starting a _node_. A
5
5
collection of connected nodes is called a <<modules-cluster,cluster>>. If you
6
6
are running a single node of {es}, then you have a cluster of one node.
7
7
@@ -25,11 +25,16 @@ dedicated data nodes, {ml} nodes, and {transform} nodes.
25
25
[[node-roles]]
26
26
==== Node roles
27
27
28
- You can define the roles of a node by setting `node.roles`. If you don't
29
- configure this setting, then the node has the following roles by default:
30
- `master`, `data`, `ingest`, `ml`.
28
+ You can define the roles of a node by setting `node.roles`. If you don't
29
+ configure this setting, then the node has the following roles by default:
31
30
32
- If you set node.roles, the node is assigned only the roles you specify.
31
+ * `master`
32
+ * `data`
33
+ * `ingest`
34
+ * `ml`
35
+ * `remote_cluster_client`
36
+
37
+ NOTE: If you set `node.roles`, the node is assigned only the roles you specify.
33
38
34
39
<<master-node,Master-eligible node>>::
35
40
@@ -49,6 +54,12 @@ document before indexing. With a heavy ingest load, it makes sense to use
49
54
dedicated ingest nodes and to not include the `ingest` role from nodes that have
50
55
the `master` or `data` roles.
51
56
57
+ <<remote-node,Remote-eligible node>>::
58
+
59
+ A node that has the `remote_cluster_client` role (default), which makes it
60
+ eligible to act as a remote client. By default, any node in the cluster can act
61
+ as a cross-cluster client and connect to remote clusters.
62
+
52
63
<<ml-node,Machine learning node>>::
53
64
54
65
A node that has `xpack.ml.enabled` and the `ml` role, which is the default
@@ -191,9 +202,9 @@ and data roles.
191
202
192
203
To create a dedicated data node, set:
193
204
[source,yaml]
194
- -------------------
205
+ ----
195
206
node.roles: [ data ]
196
- -------------------
207
+ ----
197
208
198
209
[[node-ingest-node]]
199
210
==== Ingest node
@@ -206,15 +217,15 @@ ingest nodes, that will only perform this specific task.
206
217
To create a dedicated ingest node, set:
207
218
208
219
[source,yaml]
209
- -------------------
220
+ ----
210
221
node.roles: [ ingest ]
211
- -------------------
222
+ ----
212
223
213
224
[[node-ingest-node-setting]]
214
225
// tag::node-ingest-tag[]
215
226
`node.ingest` {ess-icon}::
216
- Determines whether a node is an ingest node. <<ingest,Ingest nodes>> can apply
217
- an ingest pipeline to transform and enrich a document before indexing. Default:
227
+ Determines whether a node is an ingest node. <<ingest,Ingest nodes>> can apply
228
+ an ingest pipeline to transform and enrich a document before indexing. Default:
218
229
`true`.
219
230
// end::node-ingest-tag[]
220
231
@@ -241,9 +252,22 @@ serve the same purpose.
241
252
To create a dedicated coordinating node, set:
242
253
243
254
[source,yaml]
244
- -------------------
255
+ ----
245
256
node.roles: [ ]
246
- -------------------
257
+ ----
258
+
259
+ [[remote-node]]
260
+ ==== Remote-eligible node
261
+
262
+ By default, any node in a cluster can act as a cross-cluster client and connect
263
+ to <<modules-remote-clusters,remote clusters>>. Once connected, you can search
264
+ remote clusters using <<modules-cross-cluster-search,{ccs}>>. You can also sync
265
+ data between clusters using <<xpack-ccr,{ccr}>>.
266
+
267
+ [source,yaml]
268
+ ----
269
+ node.roles: [ remote_cluster_client ]
270
+ ----
247
271
248
272
[[ml-node]]
249
273
==== [xpack]#Machine learning node#
@@ -262,25 +286,25 @@ For more information about these settings, see <<ml-settings>>.
262
286
To create a dedicated {ml} node in the {default-dist}, set:
263
287
264
288
[source,yaml]
265
- -------------------
289
+ ----
266
290
node.roles: [ ml ]
267
291
xpack.ml.enabled: true <1>
268
- -------------------
292
+ ----
269
293
<1> The `xpack.ml.enabled` setting is enabled by default.
270
294
271
295
[[transform-node]]
272
296
==== [xpack]#{transform-cap} node#
273
297
274
- {transform-cap} nodes run {transforms} and handle {transform} API requests. If
275
- you have the {oss-dist}, do not use these settings. For more information, see
298
+ {transform-cap} nodes run {transforms} and handle {transform} API requests. If
299
+ you have the {oss-dist}, do not use these settings. For more information, see
276
300
<<transform-settings>>.
277
301
278
302
To create a dedicated {transform} node in the {default-dist}, set:
279
303
280
304
[source,yaml]
281
- -------------------
305
+ ----
282
306
node.roles: [ transform ]
283
- -------------------
307
+ ----
284
308
285
309
[[change-node-role]]
286
310
==== Changing the role of a node
@@ -300,8 +324,8 @@ Each node checks the contents of its data path at startup. If it discovers
300
324
unexpected data then it will refuse to start. This is to avoid importing
301
325
unwanted <<modules-gateway-dangling-indices,dangling indices>> which can lead
302
326
to a red cluster health. To be more precise, nodes without the `data` role will
303
- refuse to start if they find any shard data on disk at startup, and nodes
304
- without both the `master` and `data` roles will refuse to start if they have any
327
+ refuse to start if they find any shard data on disk at startup, and nodes
328
+ without both the `master` and `data` roles will refuse to start if they have any
305
329
index metadata on disk at startup.
306
330
307
331
It is possible to change the roles of a node by adjusting its
@@ -336,16 +360,16 @@ to `$ES_HOME/data` but can be configured in the `elasticsearch.yml` config
336
360
file an absolute path or a path relative to `$ES_HOME` as follows:
337
361
338
362
[source,yaml]
339
- -----------------------
363
+ ----
340
364
path.data: /var/elasticsearch/data
341
- -----------------------
365
+ ----
342
366
343
367
Like all node settings, it can also be specified on the command line as:
344
368
345
369
[source,sh]
346
- -----------------------
370
+ ----
347
371
./bin/elasticsearch -Epath.data=/var/elasticsearch/data
348
- -----------------------
372
+ ----
349
373
350
374
TIP: When using the `.zip` or `.tar.gz` distributions, the `path.data` setting
351
375
should be configured to locate the data directory outside the {es} home
0 commit comments