Skip to content

Commit 31df968

Browse files
debadairjrodewigelasticmachine
authored
[DOCS] Reuse data tier content in node role docs (#84346) (#85426) (#85429)
* [DOCS] Reuse data tier content in node role docs (#84346) Co-authored-by: Elastic Machine <[email protected]> * [DOCS] Fix duplicate anchor (#85424) * [DOCS] Fix duplicate anchor * Removed misplaced end tag Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Elastic Machine <[email protected]>
1 parent be4576b commit 31df968

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

docs/reference/datatiers.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ according to your performance, resiliency and data retention requirements.
3333
[[content-tier]]
3434
=== Content tier
3535

36+
// tag::content-tier[]
3637
Data stored in the content tier is generally a collection of items such as a product catalog or article archive.
3738
Unlike time series data, the value of the content remains relatively constant over time,
3839
so it doesn't make sense to move it to a tier with different performance characteristics as it ages.
@@ -47,11 +48,13 @@ tier should be configured to use one or more replicas.
4748

4849
The content tier is required. System indices and other indices that aren't part
4950
of a data stream are automatically allocated to the content tier.
51+
// end::content-tier[]
5052

5153
[discrete]
5254
[[hot-tier]]
5355
=== Hot tier
5456

57+
// tag::hot-tier[]
5558
The hot tier is the {es} entry point for time series data and holds your most-recent,
5659
most-frequently-searched time series data.
5760
Nodes in the hot tier need to be fast for both reads and writes,
@@ -60,22 +63,26 @@ For resiliency, indices in the hot tier should be configured to use one or more
6063

6164
The hot tier is required. New indices that are part of a <<data-streams,
6265
data stream>> are automatically allocated to the hot tier.
66+
// end::hot-tier[]
6367

6468
[discrete]
6569
[[warm-tier]]
6670
=== Warm tier
6771

72+
// tag::warm-tier[]
6873
Time series data can move to the warm tier once it is being queried less frequently
6974
than the recently-indexed data in the hot tier.
7075
The warm tier typically holds data from recent weeks.
7176
Updates are still allowed, but likely infrequent.
7277
Nodes in the warm tier generally don't need to be as fast as those in the hot tier.
7378
For resiliency, indices in the warm tier should be configured to use one or more replicas.
79+
// end::warm-tier[]
7480

7581
[discrete]
7682
[[cold-tier]]
7783
=== Cold tier
7884

85+
// tag::cold-tier[]
7986
When you no longer need to search time series data regularly, it can move from
8087
the warm tier to the cold tier. While still searchable, this tier is typically
8188
optimized for lower storage costs rather than search speed.
@@ -91,11 +98,13 @@ Fully mounted indices are read-only.
9198
Alternatively, you can use the cold tier to store regular indices with replicas instead
9299
of using {search-snaps}. This lets you store older data on less expensive hardware
93100
but doesn't reduce required disk space compared to the warm tier.
101+
// end::cold-tier[]
94102

95103
[discrete]
96104
[[frozen-tier]]
97105
=== Frozen tier
98106

107+
// tag::frozen-tier[]
99108
Once data is no longer being queried, or being queried rarely, it may move from
100109
the cold tier to the frozen tier where it stays for the rest of its life.
101110

@@ -105,6 +114,7 @@ and load data from a snapshot repository. This reduces local storage and
105114
operating costs while still letting you search frozen data. Because {es} must
106115
sometimes fetch frozen data from the snapshot repository, searches on the frozen
107116
tier are typically slower than on the cold tier.
117+
// end::frozen-tier[]
108118

109119
[discrete]
110120
[[configure-data-tiers-cloud]]

docs/reference/modules/node.asciidoc

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -238,8 +238,8 @@ that has one of the specialized data roles cannot have the generic `data` role.
238238
[[data-content-node]]
239239
==== Content data node
240240

241-
Content data nodes accommodate user-created content. They enable operations like CRUD,
242-
search and aggregations.
241+
Content data nodes are part of the content tier.
242+
include::{es-repo-dir}/datatiers.asciidoc[tag=content-tier]
243243

244244
To create a dedicated content node, set:
245245
[source,yaml]
@@ -251,8 +251,8 @@ node.roles: [ data_content ]
251251
[[data-hot-node]]
252252
==== Hot data node
253253

254-
Hot data nodes store time series data as it enters {es}. The hot tier must be fast for
255-
both reads and writes, and requires more hardware resources (such as SSD drives).
254+
Hot data nodes are part of the hot tier.
255+
include::{es-repo-dir}/datatiers.asciidoc[tag=hot-tier]
256256

257257
To create a dedicated hot node, set:
258258
[source,yaml]
@@ -264,9 +264,8 @@ node.roles: [ data_hot ]
264264
[[data-warm-node]]
265265
==== Warm data node
266266

267-
Warm data nodes store indices that are no longer being regularly updated, but are still being
268-
queried. Query volume is usually at a lower frequency than it was while the index was in the hot tier.
269-
Less performant hardware can usually be used for nodes in this tier.
267+
Warm data nodes are part of the warm tier.
268+
include::{es-repo-dir}/datatiers.asciidoc[tag=warm-tier]
270269

271270
To create a dedicated warm node, set:
272271
[source,yaml]
@@ -278,7 +277,8 @@ node.roles: [ data_warm ]
278277
[[data-cold-node]]
279278
==== Cold data node
280279

281-
Cold data nodes store read-only indices that are accessed less frequently. This tier uses less performant hardware and may leverage searchable snapshot indices to minimize the resources required.
280+
Cold data nodes are part of the cold tier.
281+
include::{es-repo-dir}/datatiers.asciidoc[tag=cold-tier]
282282

283283
To create a dedicated cold node, set:
284284
[source,yaml]
@@ -290,11 +290,10 @@ node.roles: [ data_cold ]
290290
[[data-frozen-node]]
291291
==== Frozen data node
292292

293-
The frozen tier stores <<partially-mounted,partially mounted indices>>
294-
exclusively. We recommend you use dedicated nodes in the frozen tier.
293+
Frozen data nodes are part of the frozen tier.
294+
include::{es-repo-dir}/datatiers.asciidoc[tag=frozen-tier]
295295

296296
To create a dedicated frozen node, set:
297-
298297
[source,yaml]
299298
----
300299
node.roles: [ data_frozen ]

0 commit comments

Comments
 (0)