You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[DOCS] Update ILM screenshots and tutorial (#68482) (#68585)
Changes:
- Reworks the ILM tutorial to focus on the Elastic Agent and a built-in ILM policy
- Updates several screenshots in the docs for the new ILM UI
Co-authored-by: debadair <[email protected]>
With {ilm} ({ilm-init}), you can create policies that perform actions automatically
10
-
on indices as they age and grow. {ilm-init} policies help you to manage
11
-
performance, resilience, and retention of your data during its lifecycle. This tutorial shows
12
-
you how to use {kib}’s *Index Lifecycle Policies* to modify and create {ilm-init}
13
-
policies. You can learn more about all of the actions, benefits, and lifecycle
14
-
phases in the <<overview-index-lifecycle-management, {ilm-init} overview>>.
9
+
{es} includes the following built-in {ilm-init} policies:
10
+
11
+
- `logs`
12
+
- `metrics`
13
+
- `synthetics`
14
+
15
+
The {agent} uses these policies to manage backing indices for its data streams.
16
+
This tutorial shows you how to use {kib}’s **Index Lifecycle Policies** to
17
+
customize these policies based on your application's performance, resilience,
18
+
and retention requirements.
15
19
16
20
17
21
[discrete]
18
22
[[example-using-index-lifecycle-policy-scenario]]
19
23
==== Scenario
20
24
21
-
You’re tasked with sending syslog files to an {es} cluster. This
22
-
log datahas the following data retention guidelines:
25
+
You want to send log files to an {es} cluster so you can visualize and analyze
26
+
the data. This data has the following retention requirements:
23
27
24
-
* Keep logs on hot data nodes for 30 days
25
-
* Roll over to a new index if the size reaches 50GB
26
-
* After 30 days:
27
-
** Move the logs to warm data nodes
28
-
** Set <<glossary-replica-shard, replica shards>> to 1
29
-
** <<indices-forcemerge, Force merge>> multiple index segments to free up the space used by deleted documents
30
-
* Delete logs after 90 days
28
+
* When the write index reaches 50GB or is 30 days old, roll over to a new index.
29
+
* After rollover, keep indices in the hot data tier for 30 days.
30
+
* 30 days after rollover:
31
+
** Move indices to the warm data tier.
32
+
** Set <<glossary-replica-shard, replica shards>> to 1.
33
+
** <<indices-forcemerge, Force merge>> multiple index segments to free up the
34
+
space used by deleted documents.
35
+
* Delete indices 90 days after rollover.
31
36
32
37
33
38
[discrete]
@@ -36,130 +41,80 @@ log data has the following data retention guidelines:
36
41
37
42
To complete this tutorial, you'll need:
38
43
39
-
* An {es} cluster with hot and warm nodes configured for shard allocation
40
-
awareness.
44
+
* An {es} cluster with hot and warm data tiers.
41
45
42
-
** {ess}:
43
-
Choose the Elastic Stack and then the {cloud}/ec-getting-started-profiles.html#ec-getting-started-profiles-hot-warm[hot-warm architecture] hardware profile.
46
+
** {ess}:
47
+
Elastic Stack deployments on the {ess} include a hot tier by default. To add a
48
+
warm tier, edit your deployment and click **Add capacity** for the warm data
49
+
tier.
50
+
+
51
+
[role="screenshot"]
52
+
image::images/ilm/tutorial-ilm-ess-add-warm-data-tier.png[Add a warm data tier to your deployment]
44
53
45
-
** Self-managed cluster:
46
-
Add node attributes as described for {ref}/shard-allocation-filtering.html[shard allocation filtering].
54
+
** Self-managed cluster:
55
+
Assign `data_hot` and `data_warm` roles to nodes as described in
56
+
<<data-tiers>>.
47
57
+
48
-
For example, you can set this in your `elasticsearch.yml` for each data node:
58
+
For example, include the `data_warm` node role in the `elasticsearch.yml` file
0 commit comments