Skip to content

Commit 049fcb7

Browse files
authored
[DOCS] Added settings page for ILM. (#40880)
* [DOCS] Added settings page for ILM. * [DOCS] Adding ILM settings file * [DOCS] Moved the ILM settings to a separate section * [DOCS] Linked to the rollover docs. * [DOCS] Tweaked the "required" wording.
1 parent a17c570 commit 049fcb7

File tree

4 files changed

+32
-3
lines changed

4 files changed

+32
-3
lines changed

docs/reference/ilm/getting-started-ilm.asciidoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ our writing index. We wish to roll over the index after it reaches a size
1515
of 50 gigabytes, or has been created 30 days ago, and then delete the index
1616
after 90 days.
1717

18-
=== Setting up a new policy
18+
[float]
19+
[[ilm-gs-create-policy]]
20+
=== Setting up a policy
1921

2022
There are many new features introduced by {ilm-init}, but we will only focus on
2123
a few that are needed for our example. For starters, we will use the
@@ -64,6 +66,8 @@ the index being written to after it reaches 50 gigabytes, or it is 30
6466
days old. The rollover will occur when either of these conditions is true.
6567
The index will be deleted 90 days after it is rolled over.
6668

69+
[float]
70+
[[ilm-gs-apply-policy]]
6771
=== Applying a policy to our index
6872

6973
There are <<set-up-lifecycle-policy,a few ways>> to associate a
@@ -135,6 +139,8 @@ index being the index that is being written to at a time. Rollover swaps
135139
the write index to be the new index created from rollover, and sets the
136140
alias to be read-only for the source index.
137141

142+
[float]
143+
[[ilm-gs-check-progress]]
138144
=== Checking progress
139145

140146
Now that we have an index managed by our policy, how do we tell what is going

docs/reference/index-modules.asciidoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,8 @@ specific index module:
184184

185185
`index.blocks.write`::
186186

187-
Set to `true` to disable data write operations against the index. Unlike `read_only`,
188-
this setting does not affect metadata. For instance, you can close an index with a `write`
187+
Set to `true` to disable data write operations against the index. Unlike `read_only`,
188+
this setting does not affect metadata. For instance, you can close an index with a `write`
189189
block, but not an index with a `read_only` block.
190190

191191
`index.blocks.metadata`::
@@ -285,6 +285,12 @@ Other index settings are available in index modules:
285285

286286
Control over the transaction log and background flush operations.
287287

288+
[float]
289+
=== [xpack]#{xpack} index settings#
290+
291+
<<ilm-settings,{ilm-cap}>>::
292+
293+
Specify the lifecycle policy and rollover alias for an index.
288294
--
289295

290296
include::index-modules/analysis.asciidoc[]
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[role="xpack"]
2+
[[ilm-settings]]
3+
=== {ilm-cap} settings
4+
5+
These index-level {ilm-init} settings are typically configured through index
6+
templates. For more information, see <<ilm-gs-create-policy>>.
7+
8+
`index.lifecycle.name`::
9+
The name of the policy to use to manage the index.
10+
11+
`index.lifecycle.rollover_alias`::
12+
The index alias to update when the index rolls over. Specify when using a
13+
policy that contains a rollover action. When the index rolls over, the alias is
14+
updated to reflect that the index is no longer the write index. For more
15+
information about rollover, see <<using-policies-rollover>>.

docs/reference/setup.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ include::settings/audit-settings.asciidoc[]
5252

5353
include::settings/ccr-settings.asciidoc[]
5454

55+
include::settings/ilm-settings.asciidoc[]
56+
5557
include::settings/license-settings.asciidoc[]
5658

5759
include::settings/ml-settings.asciidoc[]

0 commit comments

Comments
 (0)