Skip to content

Commit e838abb

Browse files
authored
Updates the automating rollover tutorials (#3188)
Adding more context to help orient users. For example, explaining how time is calculated from the last rollover when moving data through phases (and not from index creation). I've also added a new screenshot for the index settings page of the **Create template** wizard, to explain that that is how you tie in your template to the policy created in the previous step. Partially addresses tasks defined in #1566.
1 parent 14a88a2 commit e838abb

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

manage-data/_snippets/create-lifecycle-policy.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ You can create the policy in {{kib}} or with the [create or update policy](https
1818
:sync: kibana
1919
To create the policy from {{kib}}, open the menu and go to **Stack Management > Index Lifecycle Policies**. Click **Create policy**.
2020

21+
By default, only the hot index lifecycle phase is enabled. Enable each additional lifecycle phase that you'd like.
22+
23+
2124
:::{image} /manage-data/images/elasticsearch-reference-create-policy.png
2225
:alt: Create policy page
2326
:screenshot:
@@ -60,6 +63,8 @@ PUT _ilm/policy/timeseries_policy
6063
:::
6164
::::
6265

66+
Note that for each phase after the hot phase, you have the option to move the data into the next phase after a certain duration of time. This duration is calculated from the time of the index rollover and not from the time the index is created.
67+
6368
:::{tip}
6469
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).
6570
:::
84.6 KB
Loading

manage-data/lifecycle/index-lifecycle-management/tutorial-time-series-with-data-streams.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,21 @@ When you enable {{ilm}} for {{beats}} or the {{ls}} {{es}} output plugin, lifecy
3030
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.
3131

3232
For example, you might create a template named `timeseries_template` and use it for a future data stream named `timeseries`.
33-
34-
To enable {{ilm-init}} to manage the data stream, the template configures one {{ilm-init}} setting:
35-
36-
* `index.lifecycle.name` specifies the name of the lifecycle policy that you want to apply to the data stream.
33+
To configure {{ilm-init}} to manage the data stream, you specify the name of the lifecycle policy that you want to apply to the data stream with the `index.lifecycle.name` setting.
3734

3835
Use the {{kib}} **Create template** wizard to add a template or the [Create or update index template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template) API to add a template and apply the lifecycle policy to indices matching the template.
3936

4037
::::{tab-set}
4138
:group: kibana-api
4239
:::{tab-item} {{kib}}
4340
:sync: kibana
44-
To add an index template to a cluster using the wizard, go to **Stack Management > Index Management**. In the **Index Templates** tab, click **Create template**.
41+
To add an index template to a cluster using the wizard, go to **Stack Management > Index Management**. In the **Index Templates** tab, click **Create template** and follow the instructions.
4542

4643
![Create template page](/manage-data/images/elasticsearch-reference-create-index-template.png "")
4744

48-
This wizard invokes the create or update index template API to create the index template with the options you specify.
45+
You specify the name of the lifecycle policy that you want to apply to the data stream on the **Index settings** page.
46+
47+
![Create template page](/manage-data/images/elasticsearch-reference-tutorial-ilm-datastreams-tutorial-create-index-template.png "")
4948

5049
:::{tip}
5150
To learn about which index template options 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).

0 commit comments

Comments
 (0)