Commit a3f64c9
Expand "Configure a lifecycle policy" docs (#1906)
This PR takes a chunk out of internal issue [Requested fixes for data
lifecycle
docs](elastic/docs-content-internal#4) that
was initiated by a review of the ILM docs by our Support team.
It updates the "Configure a lifecycle policy" page to:
- Add Kibana steps where we currently show only the API steps.
- In particular, when creating an index template users aren't always
sure what to specify on the "Index settings" tab, so this adds an
example config.
- Add a page overview
- Add a section about viewing the ILM status for an index or datastream
- Fix up smaller items, such as:
- Explicitly call out the Kibana "Data retention" option.
- Emphasize that lifecycle phase changes are based on time since
rollover rather than index creation time
- Warn about updating the `logs@lifecycle` and `metrics@lifecycle`
policies since they affect a LOT of indices.
- Provide links for things like the index lifecycle actions, mappings,
etc., to help people understand these options.
**Please see preview pages**:
- [Configure a lifecycle
policy](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1906/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy)
- [Apply a lifecycle policy to an
index](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1906/manage-data/lifecycle/index-lifecycle-management/policy-apply)
- [View the lifecycle status of an
index](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1906/manage-data/lifecycle/index-lifecycle-management/policy-view-status)
- [Update or switch a lifecycle
policy](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1906/manage-data/lifecycle/index-lifecycle-management/policy-updates)
(For reference, here's the [original
version](https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy)
of the first page).
**ES Data Management team**, if any of you can please give this a
technical review I'd be very grateful! 🙏 The API instructions aren't
changed, with the exception that I added [this
section](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1906/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy#view-lifecycle-status)
about calling the _ILM explain_ API. The Kibana steps are all new.
---------
Co-authored-by: Mary Gouseti <[email protected]>
Co-authored-by: Vlada Chirmicci <[email protected]>1 parent cfc842f commit a3f64c9
File tree
14 files changed
+513
-142
lines changed- manage-data
- data-store/data-streams
- images
- lifecycle
- index-lifecycle-management
14 files changed
+513
-142
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
214 | 214 | | |
215 | 215 | | |
216 | 216 | | |
217 | | - | |
| 217 | + | |
218 | 218 | | |
219 | 219 | | |
220 | 220 | | |
221 | | - | |
222 | 221 | | |
223 | 222 | | |
224 | 223 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
390 | 390 | | |
391 | 391 | | |
392 | 392 | | |
393 | | - | |
| 393 | + | |
394 | 394 | | |
395 | 395 | | |
396 | 396 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
71 | | - | |
| 71 | + | |
| 72 | + | |
72 | 73 | | |
73 | 74 | | |
74 | 75 | | |
75 | 76 | | |
76 | | - | |
| 77 | + | |
77 | 78 | | |
78 | 79 | | |
79 | 80 | | |
| |||
Lines changed: 164 additions & 134 deletions
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| |||
0 commit comments