From 2247e52c681505e3edd70619d53789a08954991e Mon Sep 17 00:00:00 2001 From: Satyam Mishra Date: Wed, 4 Dec 2024 03:53:03 +0530 Subject: [PATCH] Updated tutorial text --- .../example-index-lifecycle-policy.asciidoc | 52 +++++++++---------- 1 file changed, 24 insertions(+), 28 deletions(-) diff --git a/docs/reference/ilm/example-index-lifecycle-policy.asciidoc b/docs/reference/ilm/example-index-lifecycle-policy.asciidoc index 6ec261fabc448..d9fb8f02e0b92 100644 --- a/docs/reference/ilm/example-index-lifecycle-policy.asciidoc +++ b/docs/reference/ilm/example-index-lifecycle-policy.asciidoc @@ -16,7 +16,6 @@ This tutorial shows you how to use {kib}’s **Index Lifecycle Policies** to customize these policies based on your application's performance, resilience, and retention requirements. - [discrete] [[example-using-index-lifecycle-policy-scenario]] ==== Scenario @@ -24,16 +23,15 @@ and retention requirements. You want to send log files to an {es} cluster so you can visualize and analyze the data. This data has the following retention requirements: -* When the write index reaches 50GB or is 30 days old, roll over to a new index. +* When the primary shard reaches 50GB or the index is 30 days old, roll over to a new index. * After rollover, keep indices in the hot data tier for 30 days. * 30 days after rollover: -** Move indices to the warm data tier. -** Set replica shards to 1. -** <> multiple index segments to free up the -space used by deleted documents. + ** Move indices to the warm data tier. + ** Set replica shards to 1. + ** <> multiple index segments to free up the + space used by deleted documents. * Delete indices 90 days after rollover. - [discrete] [[example-using-index-lifecycle-policy-prerequisites]] ==== Prerequisites @@ -43,19 +41,18 @@ To complete this tutorial, you'll need: * An {es} cluster with hot and warm data tiers. ** {ess}: -Elastic Stack deployments on {ess} include a hot tier by default. To add a warm -tier, edit your deployment and click **Add capacity** for the warm data tier. -+ +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. ++ [role="screenshot"] -image::images/ilm/tutorial-ilm-ess-add-warm-data-tier.png[Add a warm data tier to your deployment] +image::images/ilm/tutorial-ilm-add-warm-data-tier.png[Add a warm data tier to your deployment] ** Self-managed cluster: Assign `data_hot` and `data_warm` roles to nodes as described in <>. -+ ++ For example, include the `data_warm` node role in the `elasticsearch.yml` file of each node in the warm tier: -+ ++ [source,yaml] ---- node.roles: [ data_warm ] @@ -84,14 +81,13 @@ To save the `logs@lifecycle` policy as a new policy in {kib}: . On the **Edit policy logs** page, toggle **Save as new policy**, and then provide a new name for the policy, for example, `logs-custom`. The `logs@lifecycle` policy uses the recommended rollover defaults: Start writing to a new -index when the current write index reaches 50GB or becomes 30 days old. +index when the primary shard reaches 50GB or the index becomes 30 days old. To view or change the rollover settings, click **Advanced settings** for the hot -phase. Then disable **Use recommended defaults** to display the rollover -settings. +phase. Adjust the **Minimum primary shard size** and other rollover settings as needed. [role="screenshot"] -image::images/ilm/tutorial-ilm-hotphaserollover-default.png[View rollover defaults] +image::images/ilm/tutorial-ilm-hotphaserollover-new.png[View rollover defaults] [discrete] [[ilm-ex-modify-policy]] @@ -102,8 +98,8 @@ indices. You can modify your copy of the policy to meet your performance require manage resource usage. . Activate the warm phase and click **Advanced settings**. -+ --- ++ +-- .. Set **Move data into phase when** to **30 days old**. This moves indices to the warm tier 30 days after rollover. @@ -112,19 +108,19 @@ the warm tier 30 days after rollover. .. Enable **Force merge data** and set **Number of segments** to **1**. [role="screenshot"] -image::images/ilm/tutorial-ilm-modify-default-warm-phase-rollover.png[Add a warm phase with custom settings] +image::images/ilm/tutorial-ilm-modify-new-warm-phase-rollover.png[Add a warm phase with custom settings] -- . In the warm phase, click the trash icon to enable the delete phase. -+ ++ [role="screenshot"] -image::images/ilm/tutorial-ilm-enable-delete-phase.png[Enable the delete phase] -+ +image::images/ilm/tutorial-ilm-enable-delete-phase-new.png[Enable the delete phase] ++ In the delete phase, set **Move data into phase when** to **90 days old**. This deletes indices 90 days after rollover. -+ ++ [role="screenshot"] -image::images/ilm/tutorial-ilm-delete-rollover.png[Add a delete phase] +image::images/ilm/tutorial-ilm-delete-phase-new.png[Add a delete phase] . Click **Save as new policy**. @@ -141,7 +137,7 @@ A `*@custom` component template allows you to customize the mappings and setting . Click on the **Component Template** tab and click **Create component template**. . Under **Logistics**, name the component template `logs@custom`. . Under **Index settings**, set the {ilm-init} policy name created in the previous step: -+ ++ [source,JSON] -------------------------------------------------- { @@ -152,7 +148,7 @@ A `*@custom` component template allows you to customize the mappings and setting } } -------------------------------------------------- -+ ++ . Continue to **Review**, and then click **Save component template**. . Click the **Index Templates**, tab, and then select the `logs` index template. -. In the summary, view the **Component templates** list. `logs@custom` should be listed. \ No newline at end of file +. In the summary, view the **Component templates** list. `logs@custom` should be listed.