Skip to content

Commit 2247e52

Browse files
committed
Updated tutorial text
1 parent 447c4dc commit 2247e52

File tree

1 file changed

+24
-28
lines changed

1 file changed

+24
-28
lines changed

docs/reference/ilm/example-index-lifecycle-policy.asciidoc

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,22 @@ This tutorial shows you how to use {kib}’s **Index Lifecycle Policies** to
1616
customize these policies based on your application's performance, resilience,
1717
and retention requirements.
1818

19-
2019
[discrete]
2120
[[example-using-index-lifecycle-policy-scenario]]
2221
==== Scenario
2322

2423
You want to send log files to an {es} cluster so you can visualize and analyze
2524
the data. This data has the following retention requirements:
2625

27-
* When the write index reaches 50GB or is 30 days old, roll over to a new index.
26+
* When the primary shard reaches 50GB or the index is 30 days old, roll over to a new index.
2827
* After rollover, keep indices in the hot data tier for 30 days.
2928
* 30 days after rollover:
30-
** Move indices to the warm data tier.
31-
** Set replica shards to 1.
32-
** <<indices-forcemerge, Force merge>> multiple index segments to free up the
33-
space used by deleted documents.
29+
** Move indices to the warm data tier.
30+
** Set replica shards to 1.
31+
** <<indices-forcemerge, Force merge>> multiple index segments to free up the
32+
space used by deleted documents.
3433
* Delete indices 90 days after rollover.
3534

36-
3735
[discrete]
3836
[[example-using-index-lifecycle-policy-prerequisites]]
3937
==== Prerequisites
@@ -43,19 +41,18 @@ To complete this tutorial, you'll need:
4341
* An {es} cluster with hot and warm data tiers.
4442

4543
** {ess}:
46-
Elastic Stack deployments on {ess} include a hot tier by default. To add a warm
47-
tier, edit your deployment and click **Add capacity** for the warm data tier.
48-
+
44+
Elastic Stack deployments on {ess} automatically include hot and warm tiers. If needed, you can add additional warm capacity by editing your deployment and selecting **Add capacity** for the warm data tier.
45+
+
4946
[role="screenshot"]
50-
image::images/ilm/tutorial-ilm-ess-add-warm-data-tier.png[Add a warm data tier to your deployment]
47+
image::images/ilm/tutorial-ilm-add-warm-data-tier.png[Add a warm data tier to your deployment]
5148

5249
** Self-managed cluster:
5350
Assign `data_hot` and `data_warm` roles to nodes as described in
5451
<<data-tiers>>.
55-
+
52+
+
5653
For example, include the `data_warm` node role in the `elasticsearch.yml` file
5754
of each node in the warm tier:
58-
+
55+
+
5956
[source,yaml]
6057
----
6158
node.roles: [ data_warm ]
@@ -84,14 +81,13 @@ To save the `logs@lifecycle` policy as a new policy in {kib}:
8481
. On the **Edit policy logs** page, toggle **Save as new policy**, and then provide a new name for the policy, for example, `logs-custom`.
8582

8683
The `logs@lifecycle` policy uses the recommended rollover defaults: Start writing to a new
87-
index when the current write index reaches 50GB or becomes 30 days old.
84+
index when the primary shard reaches 50GB or the index becomes 30 days old.
8885

8986
To view or change the rollover settings, click **Advanced settings** for the hot
90-
phase. Then disable **Use recommended defaults** to display the rollover
91-
settings.
87+
phase. Adjust the **Minimum primary shard size** and other rollover settings as needed.
9288

9389
[role="screenshot"]
94-
image::images/ilm/tutorial-ilm-hotphaserollover-default.png[View rollover defaults]
90+
image::images/ilm/tutorial-ilm-hotphaserollover-new.png[View rollover defaults]
9591

9692
[discrete]
9793
[[ilm-ex-modify-policy]]
@@ -102,8 +98,8 @@ indices. You can modify your copy of the policy to meet your performance require
10298
manage resource usage.
10399

104100
. Activate the warm phase and click **Advanced settings**.
105-
+
106-
--
101+
+
102+
--
107103
.. Set **Move data into phase when** to **30 days old**. This moves indices to
108104
the warm tier 30 days after rollover.
109105

@@ -112,19 +108,19 @@ the warm tier 30 days after rollover.
112108
.. Enable **Force merge data** and set **Number of segments** to **1**.
113109

114110
[role="screenshot"]
115-
image::images/ilm/tutorial-ilm-modify-default-warm-phase-rollover.png[Add a warm phase with custom settings]
111+
image::images/ilm/tutorial-ilm-modify-new-warm-phase-rollover.png[Add a warm phase with custom settings]
116112
--
117113

118114
. In the warm phase, click the trash icon to enable the delete phase.
119-
+
115+
+
120116
[role="screenshot"]
121-
image::images/ilm/tutorial-ilm-enable-delete-phase.png[Enable the delete phase]
122-
+
117+
image::images/ilm/tutorial-ilm-enable-delete-phase-new.png[Enable the delete phase]
118+
+
123119
In the delete phase, set **Move data into phase when** to **90 days old**. This
124120
deletes indices 90 days after rollover.
125-
+
121+
+
126122
[role="screenshot"]
127-
image::images/ilm/tutorial-ilm-delete-rollover.png[Add a delete phase]
123+
image::images/ilm/tutorial-ilm-delete-phase-new.png[Add a delete phase]
128124

129125
. Click **Save as new policy**.
130126

@@ -141,7 +137,7 @@ A `*@custom` component template allows you to customize the mappings and setting
141137
. Click on the **Component Template** tab and click **Create component template**.
142138
. Under **Logistics**, name the component template `logs@custom`.
143139
. Under **Index settings**, set the {ilm-init} policy name created in the previous step:
144-
+
140+
+
145141
[source,JSON]
146142
--------------------------------------------------
147143
{
@@ -152,7 +148,7 @@ A `*@custom` component template allows you to customize the mappings and setting
152148
}
153149
}
154150
--------------------------------------------------
155-
+
151+
+
156152
. Continue to **Review**, and then click **Save component template**.
157153
. Click the **Index Templates**, tab, and then select the `logs` index template.
158-
. In the summary, view the **Component templates** list. `logs@custom` should be listed.
154+
. In the summary, view the **Component templates** list. `logs@custom` should be listed.

0 commit comments

Comments
 (0)