Skip to content

Commit

Permalink
[DOCS] Added settings page for ILM. (#40880)
Browse files Browse the repository at this point in the history
* [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.
  • Loading branch information
debadair committed Apr 5, 2019
1 parent cbfa0a7 commit 6cab5b8
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 3 deletions.
8 changes: 7 additions & 1 deletion docs/reference/ilm/getting-started-ilm.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ our writing index. We wish to roll over the index after it reaches a size
of 50 gigabytes, or has been created 30 days ago, and then delete the index
after 90 days.

=== Setting up a new policy
[float]
[[ilm-gs-create-policy]]
=== Setting up a policy

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

[float]
[[ilm-gs-apply-policy]]
=== Applying a policy to our index

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

[float]
[[ilm-gs-check-progress]]
=== Checking progress

Now that we have an index managed by our policy, how do we tell what is going
Expand Down
10 changes: 8 additions & 2 deletions docs/reference/index-modules.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,8 @@ specific index module:

`index.blocks.write`::

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

`index.blocks.metadata`::
Expand Down Expand Up @@ -280,6 +280,12 @@ Other index settings are available in index modules:

Control over the transaction log and background flush operations.

[float]
=== [xpack]#{xpack} index settings#

<<ilm-settings,{ilm-cap}>>::

Specify the lifecycle policy and rollover alias for an index.
--

include::index-modules/analysis.asciidoc[]
Expand Down
15 changes: 15 additions & 0 deletions docs/reference/settings/ilm-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[role="xpack"]
[[ilm-settings]]
=== {ilm-cap} settings

These index-level {ilm-init} settings are typically configured through index
templates. For more information, see <<ilm-gs-create-policy>>.

`index.lifecycle.name`::
The name of the policy to use to manage the index.

`index.lifecycle.rollover_alias`::
The index alias to update when the index rolls over. Specify when using a
policy that contains a rollover action. When the index rolls over, the alias is
updated to reflect that the index is no longer the write index. For more
information about rollover, see <<using-policies-rollover>>.
2 changes: 2 additions & 0 deletions docs/reference/setup.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ include::settings/audit-settings.asciidoc[]

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

include::settings/ilm-settings.asciidoc[]

include::settings/license-settings.asciidoc[]

include::settings/ml-settings.asciidoc[]
Expand Down

0 comments on commit 6cab5b8

Please sign in to comment.