Skip to content

Commit 3a4ac4a

Browse files
committed
Update 'Customize built-in policies' tutorial
1 parent b690042 commit 3a4ac4a

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

manage-data/lifecycle/index-lifecycle-management/tutorial-customize-built-in-policies.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ products:
99

1010
# Tutorial: Customize built-in policies
1111

12-
{{es}} includes the following built-in {{ilm-init}} policies:
12+
{{es}} includes a set of built-in {{ilm-init}} policies that govern how managed indices transition as they age. This guide demonstrates how you can customize the lifecycle of a managed index, to adjust how the index transitions across [data tiers](/manage-data/lifecycle/data-tiers.md) and what [actions](/manage-data/lifecycle/index-lifecycle-management/index-lifecycle.md#ilm-phase-actions), such as downsampling or shrinking, are performed on the index during each lifecycle phase.
13+
14+
[{{agent}}](/reference/fleet/index.md) uses the following set of built-in {{ilm-init}} policies to manage backing indices for its data streams:
1315

1416
* `logs@lifecycle`
1517
* `logs-otel@lifecycle`
@@ -19,8 +21,16 @@ products:
1921
* `traces@lifecycle`
2022
* `traces-otel@lifecycle`
2123

22-
{{agent}} uses these policies to manage backing indices for its data streams. 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.
24+
This tutorial gives the example of customizing how ingested logging data is managed. Rather than use the default lifecycle settings from the built-in `logs@lifecycle` {{ilm-init}} policy, you can use the **Index Lifecycle Policies** feature in {{kib}} to tailor a new policy based on your application’s specific performance, resilience, and retention requirements. This involves three main steps:
25+
1. [Create a duplicate of the `logs@lifecycle` policy](#example-using-index-lifecycle-policy-duplicate-ilm-policy).
26+
2. [Modify the new policy to suit your requirements](#ilm-ex-modify-policy).
27+
3. [Apply the new policy to your log data using a `logs@custom` component template](#example-using-index-lifecycle-policy-apply-policy).
28+
29+
:::{tip}
30+
If you're using [Elastic integrations](https://docs.elastic.co/en/integrations) and are not yet familiar with which data streams are associated with them, refer to [Manage the lifecycle policy for integrations data](/manage-data/lifecycle/index-lifecycle-management/manage-lifecycle-integrations-data.md).
2331

32+
If you're looking for a more advanced use case, such as customizing an ILM policy for a selected set of data streams in one or more integrations or namespaces, check the set of tutorials in [Customize data retention policies](/reference/fleet/data-streams-ilm-tutorial.md) in the {{fleet}} and {{agent}} reference documentation.
33+
:::
2434

2535
## Scenario [example-using-index-lifecycle-policy-scenario]
2636

0 commit comments

Comments
 (0)