Skip to content

Commit b12bc02

Browse files
Clarify availability of ILM and data stream lifecycle (#2532)
The scope of ILM and of data stream lifecycle should be called out more clearly, with respect to their supported deployment types and to the objects that each can manage. This adds an "Availability" section to the top of the main ILM page and the main data stream lifecycle page. Please see previews: - [Index lifecycle management](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2532/manage-data/lifecycle/index-lifecycle-management) - [Data stream lifecycle](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2532/manage-data/lifecycle/data-stream) Rel: [#190](elastic/docs-content-internal#190) --------- Co-authored-by: shainaraskas <[email protected]>
1 parent dcf32eb commit b12bc02

File tree

2 files changed

+29
-15
lines changed

2 files changed

+29
-15
lines changed

manage-data/lifecycle/data-stream.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ products:
1010

1111
# Data stream lifecycle [data-stream-lifecycle]
1212

13-
A data stream lifecycle is the built-in mechanism data streams use to manage their lifecycle. It enables you to easily automate the management of your data streams according to your retention requirements. For example, you could configure the lifecycle to:
13+
A data stream lifecycle is the built-in mechanism [data streams](/manage-data/data-store/data-streams.md) use to manage their lifecycle. It enables you to easily automate the management of your data streams according to your retention requirements. For example, you could configure the lifecycle to:
1414

1515
* Ensure that data indexed in the data stream will be kept at least for the retention time you defined.
1616
* Ensure that data older than the retention period will be deleted automatically by {{es}} at a later time.
@@ -22,6 +22,13 @@ To achieve that, it supports:
2222

2323
A data stream lifecycle also supports downsampling the data stream backing indices. See [the downsampling example](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle) for more details.
2424

25+
## Data stream lifecycle availability
26+
27+
Note the availability of data stream lifecycle to ensure that it's applicable for your use case:
28+
29+
* Data stream lifecycle is supported only for data streams and cannot be used with individual indices.
30+
31+
* Data stream lifecycle is supported for all deployment types on the versioned {{stack}} as well as for {{es-serverless}}.
2532

2633
## How does it work? [data-streams-lifecycle-how-it-works]
2734

manage-data/lifecycle/index-lifecycle-management.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,42 @@ mapped_pages:
77
- https://www.elastic.co/guide/en/cloud/current/ec-configure-index-management.html
88
applies_to:
99
stack: ga
10+
serverless: unavailable
1011
products:
1112
- id: elasticsearch
1213
---
1314

1415
# Index lifecycle management
1516

16-
{{ilm-cap}} ({{ilm-init}}) provides an integrated and streamlined way to manage time-based data such as logs and metrics, making it easier to follow best practices for managing your indices.
17-
18-
You can configure {{ilm-init}} policies to automatically manage indices according to your performance, resiliency, and retention requirements. For example, you could use {{ilm-init}} to:
17+
{{ilm-cap}} ({{ilm-init}}) provides an integrated and streamlined way to manage your time series data. You can configure {{ilm-init}} policies to automatically manage indices according to your performance, resiliency, and retention requirements. For example, you could use {{ilm-init}} to:
1918

2019
* Spin up a new index when an index reaches a certain size or number of documents
2120
* Create a new index each day, week, or month and archive previous ones
2221
* Delete stale indices to enforce data retention standards
2322

24-
::::{tip}
25-
{{ilm-init}} is not available on {{es-serverless}}.
26-
27-
:::{dropdown} Why?
28-
In an {{ecloud}} or self-managed environment, ILM lets you automatically transition indices through data tiers according to your performance needs and retention requirements. This allows you to balance hardware costs with performance. {{es-serverless}} eliminates this complexity by optimizing your cluster performance for you.
29-
30-
Data stream lifecycle is an optimized lifecycle tool that lets you focus on the most common lifecycle management needs, without unnecessary hardware-centric concepts like data tiers.
31-
:::
32-
::::
33-
3423
::::{important}
3524
To use {{ilm-init}}, all nodes in a cluster must run the same version. Although it might be possible to create and apply policies in a mixed-version cluster, there is no guarantee they will work as intended. Attempting to use a policy that contains actions that aren’t supported on all nodes in a cluster will cause errors.
3625
::::
3726

38-
## Actions
27+
## {{ilm-init}} availability
28+
29+
Note the availability of {{ilm-init}} to ensure that it's applicable for your use case.
30+
31+
* You can use {{ilm-init}} to manage indices and data streams:
32+
33+
* **Indices:** You use {{ilm-init}} to manage a specific index or set of indices by defining a lifecycle policy and applying it to the indices or an index alias. Each index is then evaluated against its policy and transitions through phases (`hot`, `warm`, `cold`, `frozen`, `delete`) based on pre-defined conditions. This approach allows for more granular control over each index but requires considerably more effort compared to using a data stream, which is our recommended option.
34+
35+
* **Data streams:** A [data stream](/manage-data/data-store/data-streams.md) acts as a layer of abstraction over a set of indices that contain append-only, time series data. You can configure {{ilm-init}} using a data stream as a single named resource, so that rollover and any other configured actions are performed on the data stream's backing indices automatically.
36+
37+
* {{ilm-init}} is available for all deployment types on the versioned {{stack}} but is not available for {{es-serverless}}. In a {{serverless-short}} environment, [data stream lifecycle](/manage-data/lifecycle/data-stream.md) is available as a data lifecycle option.
38+
39+
:::{admonition} Simpler lifecycle management in Serverless environments
40+
{{ilm-init}} lets you automatically transition indices through data tiers according to your performance needs and retention requirements. This allows you to balance hardware costs with performance. {{ilm-init}} is not available in {{serverless-short}} because in that environment your cluster performance is optimized for you. Instead, data stream lifecycle is available as a data management option.
41+
42+
Data stream lifecycle is a simpler lifecycle management tool optimized for the most common lifecycle management needs. It enables you to configure the retention duration for your data and to optimize how the data is stored, without hardware-centric concepts like data tiers. For a detailed comparison of {{ilm-init}} and data stream lifecycle refer to [Data lifecycle](/manage-data/lifecycle.md).
43+
:::
44+
45+
## Index lifecycle actions
3946

4047
{{ilm-init}} policies can trigger actions like:
4148

0 commit comments

Comments
 (0)