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
There are no details about the default ILM policy settings or index template options in the Rollover tutorial, so I'm adding them as these topics are relevant to expore. I'm also adding a link to the page about viewing the lifecycle of an existing index or data stream into the tutorial.
Fixes#1562
When you continuously index timestamped documents into {{es}}, you typically use a [data stream](../../data-store/data-streams.md) so you can periodically [roll over](rollover.md) to a new index. This enables you to implement a [hot-warm-cold architecture](../data-tiers.md) to meet your performance requirements for your newest data, control costs over time, enforce retention policies, and still get the most out of your data.
12
+
When you continuously index timestamped documents into {{es}}, you typically use a [data stream](../../data-store/data-streams.md) so you can periodically [roll over](rollover.md) to a new index. This enables you to implement a [hot-warm-cold architecture](../data-tiers.md) to meet the performance requirements for your newest data, control costs over time, enforce retention policies, and still get the most out of your data.
13
13
14
14
To simplify index management and automate rollover, select one of the scenarios that best applies to your situation:
15
15
@@ -36,7 +36,7 @@ When you enable {{ilm}} for {{beats}} or the {{ls}} {{es}} output plugin, lifecy
36
36
37
37
A lifecycle policy specifies the phases in the index lifecycle and the actions to perform in each phase. A lifecycle can have up to five phases: `hot`, `warm`, `cold`, `frozen`, and `delete`.
38
38
39
-
For example, you might define a `timeseries_policy` that has two phases:
39
+
For example, you might define a policy named `timeseries_policy` that has the following two phases:
40
40
41
41
* A `hot` phase that defines a rollover action to specify that an index rolls over when it reaches either a `max_primary_shard_size` of 50 gigabytes or a `max_age` of 30 days.
42
42
* A `delete` phase that sets `min_age` to remove the index 90 days after rollover.
@@ -87,26 +87,33 @@ PUT _ilm/policy/timeseries_policy
87
87
88
88
::::
89
89
90
+
:::{tip}
91
+
For more details about default {{ilm-init}} policy settings, refer to [Create a lifecycle policy](/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy.md#ilm-create-policy).
92
+
:::
90
93
91
94
92
95
### Create an index template to create the data stream and apply the lifecycle policy [ilm-gs-apply-policy]
93
96
94
97
To set up a data stream, first create an index template to specify the lifecycle policy. Because the template is for a data stream, it must also include a `data_stream` definition.
95
98
96
-
For example, you might create a `timeseries_template`to use for a future data stream named `timeseries`.
99
+
For example, you might create a template named `timeseries_template`and use for a future data stream named `timeseries`.
97
100
98
-
To enable the {{ilm-init}} to manage the data stream, the template configures one {{ilm-init}} setting:
101
+
To enable {{ilm-init}} to manage the data stream, the template configures one {{ilm-init}} setting:
99
102
100
-
*`index.lifecycle.name` specifies the name of the lifecycle policy to apply to the data stream.
103
+
*`index.lifecycle.name` specifies the name of the lifecycle policy that you want to apply to the data stream.
101
104
102
-
You can use the {{kib}} Create template wizard to add the template. From Kibana, open the menu and go to **Stack Management > Index Management**. In the **Index Templates** tab, click **Create template**.
105
+
You can use the {{kib}} **Create template** wizard to add the template. From {{kib}}, open the menu and go to **Stack Management > Index Management**. In the **Index Templates** tab, click **Create template**.
This wizard invokes the [create or update index template API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template) to create the index template with the options you specify.
109
112
113
+
:::{tip}
114
+
For more information about the available index template options that you can specify, refer to [Create an index template to apply the lifecycle policy](/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy.md#apply-policy-template).
115
+
:::
116
+
110
117
::::{dropdown} API example
111
118
```console
112
119
PUT _index_template/timeseries_template
@@ -155,7 +162,7 @@ This process repeats each time a rollover condition is met. You can search acros
To get status information for managed indices, you use the {{ilm-init}} explain API. This lets you find out things like:
165
+
To get status information for managed indices, you can use {{kib}} to [view their current status, including details about the ILM policy](/manage-data/lifecycle/index-lifecycle-management/policy-view-status.md) or the {{ilm-init}} explain API. This lets you find out things like:
159
166
160
167
* What phase an index is in and when it entered that phase.
161
168
* The current action and what step is being performed.
@@ -421,6 +428,8 @@ Create a data stream using the [_data_stream API](https://www.elastic.co/docs/ap
421
428
PUT /_data_stream/movetods
422
429
```
423
430
431
+
You can [view the lifecycle status of your data stream](/manage-data/lifecycle/index-lifecycle-management/policy-view-status.md), including details about its associated ILM policy.
432
+
424
433
### Optional: Reindex your data with a data stream [manage-general-content-with-data-streams-reindex]
425
434
426
435
If you want to copy your documents from an existing index to the data stream you created, reindex with a data stream using the [_reindex API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex):
0 commit comments