Skip to content

Commit 551011c

Browse files
authored
[DOCS] Clarify behavior of the generic data node role (#106375) (#109692)
(cherry picked from commit 82d7e4e)
1 parent 78d6034 commit 551011c

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

docs/reference/modules/node.asciidoc

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ A node that has the `master` role, which makes it eligible to be
6868

6969
<<data-node,Data node>>::
7070

71-
A node that has the `data` role. Data nodes hold data and perform data
72-
related operations such as CRUD, search, and aggregations. A node with the `data` role can fill any of the specialised data node roles.
71+
A node that has one of several data roles. Data nodes hold data and perform data
72+
related operations such as CRUD, search, and aggregations. A node with a generic `data` role can fill any of the specialized data node roles.
7373

7474
<<node-ingest-node,Ingest node>>::
7575

@@ -220,7 +220,7 @@ therefore ensure that the storage and networking available to the nodes in your
220220
cluster are good enough to meet your performance goals.
221221

222222
[[data-node]]
223-
==== Data node
223+
==== Data nodes
224224

225225
Data nodes hold the shards that contain the documents you have indexed. Data
226226
nodes handle data related operations like CRUD, search, and aggregations.
@@ -230,20 +230,27 @@ monitor these resources and to add more data nodes if they are overloaded.
230230
The main benefit of having dedicated data nodes is the separation of the master
231231
and data roles.
232232

233-
To create a dedicated data node, set:
233+
In a multi-tier deployment architecture, you use specialized data roles to
234+
assign data nodes to specific tiers: `data_content`,`data_hot`, `data_warm`,
235+
`data_cold`, or `data_frozen`. A node can belong to multiple tiers.
236+
237+
If you want to include a node in all tiers, or if your cluster does not use multiple tiers, then you can use the generic `data` role.
238+
239+
WARNING: If you assign a node to a specific tier using a specialized data role, then you shouldn't also assign it the generic `data` role. The generic `data` role takes precedence over specialized data roles.
240+
241+
[[generic-data-node]]
242+
===== Generic data node
243+
244+
Generic data nodes are included in all content tiers.
245+
246+
To create a dedicated generic data node, set:
234247
[source,yaml]
235248
----
236249
node.roles: [ data ]
237250
----
238251

239-
In a multi-tier deployment architecture, you use specialized data roles to
240-
assign data nodes to specific tiers: `data_content`,`data_hot`, `data_warm`,
241-
`data_cold`, or `data_frozen`. A node can belong to multiple tiers, but a node
242-
that has one of the specialized data roles cannot have the generic `data` role.
243-
244-
[role="xpack"]
245252
[[data-content-node]]
246-
==== Content data node
253+
===== Content data node
247254

248255
Content data nodes are part of the content tier.
249256
include::{es-repo-dir}/datatiers.asciidoc[tag=content-tier]
@@ -254,9 +261,8 @@ To create a dedicated content node, set:
254261
node.roles: [ data_content ]
255262
----
256263

257-
[role="xpack"]
258264
[[data-hot-node]]
259-
==== Hot data node
265+
===== Hot data node
260266

261267
Hot data nodes are part of the hot tier.
262268
include::{es-repo-dir}/datatiers.asciidoc[tag=hot-tier]
@@ -267,9 +273,8 @@ To create a dedicated hot node, set:
267273
node.roles: [ data_hot ]
268274
----
269275

270-
[role="xpack"]
271276
[[data-warm-node]]
272-
==== Warm data node
277+
===== Warm data node
273278

274279
Warm data nodes are part of the warm tier.
275280
include::{es-repo-dir}/datatiers.asciidoc[tag=warm-tier]
@@ -280,9 +285,8 @@ To create a dedicated warm node, set:
280285
node.roles: [ data_warm ]
281286
----
282287

283-
[role="xpack"]
284288
[[data-cold-node]]
285-
==== Cold data node
289+
===== Cold data node
286290

287291
Cold data nodes are part of the cold tier.
288292
include::{es-repo-dir}/datatiers.asciidoc[tag=cold-tier]
@@ -293,9 +297,8 @@ To create a dedicated cold node, set:
293297
node.roles: [ data_cold ]
294298
----
295299

296-
[role="xpack"]
297300
[[data-frozen-node]]
298-
==== Frozen data node
301+
===== Frozen data node
299302

300303
Frozen data nodes are part of the frozen tier.
301304
include::{es-repo-dir}/datatiers.asciidoc[tag=frozen-tier]

0 commit comments

Comments
 (0)