Skip to content

Commit 1affd66

Browse files
Add UI steps to 'Update existing data stream' tutorial (#2643)
The current [Update existing data stream](https://www.elastic.co/docs/manage-data/lifecycle/data-stream/tutorial-update-existing-data-stream) page shows API steps but not the equivalent procedure for doing things in the UI, so this adds in those steps. @yetanothertw ~~This isn't ready for review yet,~~ but regarding our discussion [here](#1570 (comment)), I'm thinking that this might be an example of how we can improve the "Data stream lifecycle section" to try and achieve parity with what we now have in the ILM section, if you think that's a good approach. Please see: [preview page](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2643/manage-data/lifecycle/data-stream/tutorial-update-existing-data-stream) Closes: elastic/docs-content-internal#232 --------- Co-authored-by: Vlada Chirmicci <[email protected]>
1 parent b69b60b commit 1affd66

File tree

3 files changed

+90
-8
lines changed

3 files changed

+90
-8
lines changed
103 KB
Loading
107 KB
Loading

manage-data/lifecycle/data-stream/tutorial-update-existing-data-stream.md

Lines changed: 90 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,42 @@ products:
1010

1111
# Tutorial: Update existing data stream [tutorial-manage-existing-data-stream]
1212

13-
To update the lifecycle of an existing data stream you do the following actions:
13+
To update the lifecycle of an existing data stream, perform the following actions:
1414

1515
1. [Set a data stream’s lifecycle](#set-lifecycle)
1616
2. [Remove lifecycle for a data stream](#delete-lifecycle)
1717

1818

1919
## Set a data stream’s lifecycle [set-lifecycle]
2020

21-
To add or to change the retention period of your data stream you can use the [PUT lifecycle API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle).
21+
To add or to change the retention period of your data stream you can use the **Index Management** tools in {{kib}} or the {{es}} [lifecycle API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle).
22+
23+
24+
:::::{tab-set}
25+
:group: kibana-api
26+
:::{tab-item} {{kib}}
27+
:sync: kibana
28+
29+
To change the data retention settings for a data stream:
30+
31+
1. Go to **Stack Management > Index Management** and open the **Data Streams** tab.
32+
1. Use the search tool to find the data stream you're looking for.
33+
1. Select the data stream to view its details.
34+
1. In the data stream details pane, select **Manage > Edit data retention** to adjust the settings. You can do any of the following:
35+
36+
- Select how long to retain your data, in days, hours, minutes, or seconds.
37+
- Choose to **Keep data indefinitely**, so that your data will not be deleted. Your data stream is still managed but the data will never be deleted. Managing a time series data stream such as for logs or metrics enables {{es}} to better store your data even if you do not use a retention period.
38+
- Disable **Enable data retention** to turn off data stream lifecycle management for your data stream.
39+
40+
Note that if the data stream is already managed by [{{ilm-init}}](/manage-data/lifecycle/index-lifecycle-management.md), to edit the data retention settings you must edit the associated {{ilm-init}} policy.
41+
42+
43+
:::
44+
45+
:::{tab-item} API
46+
:sync: api
47+
48+
To change the data retention settings for a data stream:
2249

2350
* You can set infinite retention period, meaning that your data should never be deleted. For example:
2451

@@ -27,7 +54,7 @@ To add or to change the retention period of your data stream you can use the [PU
2754
{ } <1>
2855
```
2956

30-
1. An empty payload means that your data stream is still managed but the data will never be deleted. Managing a time series data stream such as logs or metrics enables {{es}} to better store your data even if you do not use a retention period.
57+
1. An empty payload means that your data stream is still managed but the data will never be deleted. Managing a time series data stream such as for logs or metrics enables {{es}} to better store your data even if you do not use a retention period.
3158

3259
* Or you can set the retention period of your choice. For example:
3360

@@ -39,9 +66,32 @@ To add or to change the retention period of your data stream you can use the [PU
3966
```
4067

4168
1. The retention period of this data stream is set to 30 days. This means that {{es}} is allowed to delete data that is older than 30 days at its own discretion.
69+
:::
70+
:::::
71+
72+
The changes in the lifecycle are applied on all backing indices of the data stream.
73+
74+
You can see the effect of the change in {{kib}} or using the {{es}} [explain API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle):
75+
76+
:::::{tab-set}
77+
:group: kibana-api
78+
:::{tab-item} {{kib}}
79+
:sync: kibana
80+
To check the data retention settings for a data stream:
81+
82+
1. Go to **Stack Management > Index Management** and open the **Data Streams** tab.
83+
1. Use the search tool to find the data stream you're looking for.
84+
1. Select the data stream to view its details. The flyout shows the data retention settings for the data stream. Note that if the data stream is currently managed by an [{{ilm-init}} policy](/manage-data/lifecycle/index-lifecycle-management.md), the **Effective data retention** may differ from the retention value that you've set in the data stream, as indicated by the **Data retention**.
85+
86+
:::{image} /manage-data/images/elasticsearch-reference-lifecycle-status.png
87+
:alt: Index lifecycle status page
88+
:width: 500px
89+
:::
4290

91+
:::{tab-item} API
92+
:sync: api
4393

44-
The changes in the lifecycle are applied on all backing indices of the data stream. You can see the effect of the change via the [explain API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle):
94+
To check the data retention settings for a data stream:
4595

4696
```console
4797
GET .ds-my-data-stream-*/_lifecycle/explain
@@ -90,16 +140,48 @@ The response will look like:
90140
9. The time that will be used to determine when it’s safe to delete this index and all its data.
91141
10. The data retention for this index as well is at least 30 days, as it was recently updated.
92142

93-
143+
:::
144+
:::::
94145

95146
## Remove lifecycle for a data stream [delete-lifecycle]
96147

97-
To remove the lifecycle of a data stream you can use the [delete lifecycle API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle). As consequence, the maintenance operations that were applied by the lifecycle will no longer be applied to the data stream and all its backing indices. For example:
148+
To remove the lifecycle of a data stream you can use the **Index Management** tools in {{kib}} or the {{es}} [delete lifecycle API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle).
149+
150+
151+
:::::{tab-set}
152+
:group: kibana-api
153+
:::{tab-item} {{kib}}
154+
:sync: kibana
155+
156+
To remove a data stream's lifecycle:
157+
158+
1. Go to **Stack Management > Index Management** and open the **Data Streams** tab.
159+
1. Use the search tool to find the data stream you're looking for.
160+
1. Select the data stream to view its details.
161+
1. In the data stream details pane, select **Manage > Edit data retention**.
162+
1. Turn off the **Enable data retention** option and save your changes. The maintenance operations that were applied by the lifecycle will no longer be applied to the data stream and all of its backing indices.
163+
164+
You can confirm your changes by reopening the data stream pane. The **Effective data retention** will show a **Disabled** status.
165+
166+
::::{image} /manage-data/images/elasticsearch-reference-lifecycle-disabled.png
167+
:alt: Index lifecycle status is disabled
168+
:width: 500px
169+
::::
170+
171+
172+
:::
173+
174+
:::{tab-item} API
175+
:sync: api
176+
177+
To remove a data stream's lifecycle:
98178

99179
```console
100180
DELETE _data_stream/my-data-stream/_lifecycle
101181
```
102182

183+
After running the API request, the maintenance operations that were applied by the lifecycle will no longer be applied to the data stream and all of its backing indices.
184+
103185
You can then use the [explain API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle) again to see that the indices are no longer managed.
104186

105187
```console
@@ -125,5 +207,5 @@ GET .ds-my-data-stream-*/_lifecycle/explain
125207
2. Indication that the index is not managed by the data stream lifecycle.
126208
3. The name of another backing index.
127209
4. Indication that the index is not managed by the data stream lifecycle.
128-
129-
210+
:::
211+
:::::

0 commit comments

Comments
 (0)