Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated tutorial text #117940

Closed
wants to merge 5 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 24 additions & 28 deletions docs/reference/ilm/example-index-lifecycle-policy.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,22 @@ 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

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.
** <<indices-forcemerge, Force merge>> multiple index segments to free up the
space used by deleted documents.
** Move indices to the warm data tier.
** Set replica shards to 1.
** <<indices-forcemerge, Force merge>> 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
Expand All @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They do not automatically include a warm tier. They include a hot and content tier.

Suggested change
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.
Elastic Stack deployments on {ess} automatically include hot and content 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]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason you changed this image link? As part of this the pngs should be updated to show the newer UI.


** Self-managed cluster:
Assign `data_hot` and `data_warm` roles to nodes as described in
<<data-tiers>>.
+
+
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 ]
Expand Down Expand Up @@ -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.
Comment on lines -90 to +87
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A user will still need to uncheck the "Use recommended defaults" right?


[role="screenshot"]
image::images/ilm/tutorial-ilm-hotphaserollover-default.png[View rollover defaults]
image::images/ilm/tutorial-ilm-hotphaserollover-new.png[View rollover defaults]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This image doesn't exist, do you need to add it to git so it's committed for this PR?


[discrete]
[[ilm-ex-modify-policy]]
Expand All @@ -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**.
+
--
+
--
Comment on lines +101 to +102
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a lot of unnecessary whitespace changes in this file, can you undo those?

.. Set **Move data into phase when** to **30 days old**. This moves indices to
the warm tier 30 days after rollover.

Expand All @@ -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**.

Expand All @@ -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]
--------------------------------------------------
{
Expand All @@ -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.
. In the summary, view the **Component templates** list. `logs@custom` should be listed.