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
Copy file name to clipboardExpand all lines: manage-data/lifecycle/index-lifecycle-management/tutorial-automate-rollover.md
+43-13Lines changed: 43 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,14 +47,24 @@ The `min_age` value is relative to the rollover time, not the index creation tim
47
47
::::
48
48
49
49
50
-
You can create the policy through {{kib}} or with the [create or update policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle) API. To create the policy from {{kib}}, open the menu and go to **Stack Management > Index Lifecycle Policies**. Click **Create policy**.
50
+
You can create the policy in {{kib}} or with the [create or update policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle) API.
51
+
52
+
::::{tab-set}
53
+
:group: kibana-api
54
+
:::{tab-item} {{kib}}
55
+
:sync: kibana
56
+
To create the policy from {{kib}}, open the menu and go to **Stack Management > Index Lifecycle Policies**. Click **Create policy**.
Use the [Create or update policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle) API to add an ILM policy to the {{es}} cluster:
56
67
57
-
::::{dropdown} API example
58
68
```console
59
69
PUT _ilm/policy/timeseries_policy
60
70
{
@@ -84,7 +94,7 @@ PUT _ilm/policy/timeseries_policy
84
94
3. Move the index into the `delete` phase 90 days after rollover.
85
95
4. Trigger the `delete` action when the index enters the delete phase.
86
96
87
-
97
+
:::
88
98
::::
89
99
90
100
:::{tip}
@@ -102,19 +112,27 @@ To enable {{ilm-init}} to manage the data stream, the template configures one {{
102
112
103
113
*`index.lifecycle.name` specifies the name of the lifecycle policy that you want to apply to the data stream.
104
114
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**.
115
+
You can use the {{kib}} **Create template** wizard to add the 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 an index template to a cluster and apply the lifecycle policy to indices matching the template.
To add an index template to a cluster, go to **Stack Management > Index Management**. In the **Index Templates** tab, click **Create template**.
110
122
111
-
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.
This wizard invokes the create or update index template API to create the index template with the options you specify.
126
+
127
+
:::{tip}
114
128
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
129
:::
130
+
:::
131
+
132
+
:::{tab-item} API
133
+
:sync: api
134
+
Use the API to add an index template to your cluster:
116
135
117
-
::::{dropdown} API example
118
136
```console
119
137
PUT _index_template/timeseries_template
120
138
{
@@ -133,7 +151,7 @@ PUT _index_template/timeseries_template
133
151
1. Apply the template when a document is indexed into the `timeseries` target.
134
152
2. The name of the {{ilm-init}} policy used to manage the data stream.
135
153
136
-
154
+
:::
137
155
::::
138
156
139
157
@@ -245,10 +263,21 @@ To enable automatic rollover, the template configures two {{ilm-init}} settings:
245
263
*`index.lifecycle.name` specifies the name of the lifecycle policy to apply to new indices that match the index pattern.
246
264
*`index.lifecycle.rollover_alias` specifies the index alias to be rolled over when the rollover action is triggered for an index.
247
265
248
-
You can use the {{kib}} Create template wizard to add the template. To access the wizard, open the menu and go to **Stack Management > Index Management**. In the **Index Templates** tab, click **Create template**.
266
+
::::{tab-set}
267
+
:group: kibana-api
268
+
:::{tab-item} {{kib}}
269
+
:sync: kibana
270
+
To use the {{kib}} **Create template** wizard to add the template, go to **Stack Management > Index Management**. In the **Index Templates** tab, click **Create template**.
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).
276
+
:::
277
+
:::
278
+
279
+
:::{tab-item} API
280
+
:sync: api
252
281
The create template request for the example template looks like this:
253
282
254
283
```console
@@ -270,7 +299,8 @@ PUT _index_template/timeseries_template
270
299
2. The name of the lifecycle policy to apply to each new index.
271
300
3. The name of the alias used to reference these indices. Required for policies that use the rollover action.
272
301
273
-
302
+
:::
303
+
::::
274
304
275
305
### Bootstrap the initial time series index with a write index alias [ilm-gs-alias-bootstrap]
0 commit comments