Skip to content

Commit 3635bd7

Browse files
andreidanjrodewigdakrone
authored
[DOCS] Make ILM documentation data stream aware (elastic#58035) (elastic#58110)
Co-authored-by: James Rodewig <james.rodewig@elastic.co> Co-authored-by: Lee Hinman <dakrone@users.noreply.github.com> (cherry picked from commit 25cbbe5) Signed-off-by: Andrei Dan <andrei.dan@elastic.co>
1 parent 03dd73d commit 3635bd7

File tree

6 files changed

+301
-78
lines changed

6 files changed

+301
-78
lines changed

docs/reference/glossary.asciidoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,10 +268,15 @@ shard will never be started on the same node as its primary shard.
268268
--
269269
// tag::rollover-def[]
270270
// tag::rollover-def-short[]
271-
Redirect an alias to begin writing to a new index when the existing index reaches a certain age, number of docs, or size.
271+
272+
Creates a new index for a rollover target when the existing index reaches a certain size, number of docs, or age.
273+
A rollover target can be either an <<indices-aliases, index alias>> or a <<data-streams, data stream>>.
272274
// end::rollover-def-short[]
273-
The new index is automatically configured according to any matching <<glossary-index-template, index templates>>.
274-
For example, if you're indexing log data, you might use rollover to create daily or weekly indices.
275+
276+
The new index is automatically configured according to any matching <<glossary-index-template,index templates>> or
277+
respectively, a <<indices-templates,composable index template>> if the rollover target is a
278+
<<data-streams, data stream>>.
279+
For example, if you're indexing log data, you might use rollover to create daily or weekly indices.
275280
See the {ref}/indices-rollover-index.html[rollover index API].
276281
// end::rollover-def[]
277282
--

docs/reference/ilm/actions/ilm-rollover.asciidoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,20 @@
44

55
Phases allowed: hot.
66

7-
Rolls an alias over to a new index when the existing index meets one of the rollover conditions.
7+
Rolls over a target to a new index when the existing index meets one of the rollover conditions.
88

9-
IMPORTANT: If the rollover action is used on a <<ccr-put-follow,follower index>>,
9+
IMPORTANT: If the rollover action is used on a <<ccr-put-follow,follower index>>,
1010
policy execution waits until the leader index rolls over (or is
11-
<<skipping-rollover, otherwise marked complete>>),
12-
then converts the follower index into a regular index with the
11+
<<skipping-rollover, otherwise marked complete>>),
12+
then converts the follower index into a regular index with the
1313
<<ilm-unfollow-action, Unfollow action>>.
1414

15-
For a managed index to be rolled over:
15+
A rollover target can be a <<data-streams, data stream>> or an <<indices-aliases, index alias>>.
16+
When targeting a data stream, the new index becomes the data stream's
17+
<<data-stream-write-index,write index>> and its generation is incremented.
18+
19+
To roll over an <<indices-aliases, index alias>>, the alias and its write index
20+
must meet the following conditions:
1621

1722
* The index name must match the pattern '^.*-\\d+$', for example (`my_index-000001`).
1823
* The `index.lifecycle.rollover_alias` must be configured as the alias to roll over.

docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@ Phases allowed: cold.
66

77
Takes a snapshot of the managed index in the configured repository
88
and mounts it as a searchable snapshot.
9+
If the managed index is part of a <<data-streams, data stream>>,
10+
the mounted index replaces the original index in the data stream.
11+
12+
[NOTE]
13+
This action cannot be performed on a data stream's write index. Attempts to do
14+
so will fail. To convert the index to a searchable snapshot, first
15+
<<manually-roll-over-a-data-stream,manually roll over>> the data stream. This
16+
creates a new write index. Because the index is no longer the stream's write
17+
index, the action can then convert it to a searchable snapshot.
18+
Using a policy that makes use of the <<ilm-rollover, rollover>> action
19+
in the hot phase will avoid this situation and the need for a manual rollover for future
20+
managed indices.
921

1022
By default, this snapshot is deleted by the <<ilm-delete-action, delete action>> in the delete phase.
1123
To keep the snapshot, set `delete_searchable_snapshot` to `false` in the delete action.

docs/reference/ilm/actions/ilm-shrink.asciidoc

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@ policy execution waits until the leader index rolls over (or is
2121
then converts the follower index into a regular index with the
2222
<<ilm-unfollow-action,the Unfollow action>> before performing the shrink operation.
2323

24+
If the managed index is part of a <<data-streams, data stream>>,
25+
the shrunken index replaces the original index in the data stream.
26+
27+
[NOTE]
28+
This action cannot be performed on a data stream's write index. Attempts to do
29+
so will fail. To shrink the index, first
30+
<<manually-roll-over-a-data-stream,manually roll over>> the data stream. This
31+
creates a new write index. Because the index is no longer the stream's write
32+
index, the action can resume shrinking it.
33+
Using a policy that makes use of the <<ilm-rollover, rollover>> action
34+
in the hot phase will avoid this situation and the need for a manual rollover for future
35+
managed indices.
36+
2437
[[ilm-shrink-options]]
2538
==== Shrink options
2639
`number_of_shards`::
@@ -48,4 +61,4 @@ PUT _ilm/policy/my_policy
4861
}
4962
}
5063
}
51-
--------------------------------------------------
64+
--------------------------------------------------

0 commit comments

Comments
 (0)