From 63ed866517b9e50248f58fa75ca9345d69116cc1 Mon Sep 17 00:00:00 2001 From: Deb Adair Date: Thu, 4 Apr 2019 17:38:10 -0700 Subject: [PATCH 1/5] [DOCS] Added settings page for ILM. --- docs/reference/ilm/getting-started-ilm.asciidoc | 8 +++++++- docs/reference/index-modules.asciidoc | 8 ++++++-- docs/reference/setup.asciidoc | 2 ++ 3 files changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/reference/ilm/getting-started-ilm.asciidoc b/docs/reference/ilm/getting-started-ilm.asciidoc index f06c95f49c067..3d1935721643b 100644 --- a/docs/reference/ilm/getting-started-ilm.asciidoc +++ b/docs/reference/ilm/getting-started-ilm.asciidoc @@ -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 @@ -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 <> to associate a @@ -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 diff --git a/docs/reference/index-modules.asciidoc b/docs/reference/index-modules.asciidoc index 6c6858125c5cf..ac9df3db0d4d4 100644 --- a/docs/reference/index-modules.asciidoc +++ b/docs/reference/index-modules.asciidoc @@ -184,8 +184,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`:: @@ -256,6 +256,10 @@ Other index settings are available in index modules: Settings to define analyzers, tokenizers, token filters and character filters. +[xpack]#<>#:: + + Specify the lifecycle policy and rollover alias for an index. + <>:: Control over where, when, and how shards are allocated to nodes. diff --git a/docs/reference/setup.asciidoc b/docs/reference/setup.asciidoc index d54941ed6aad5..d2d46670809a2 100644 --- a/docs/reference/setup.asciidoc +++ b/docs/reference/setup.asciidoc @@ -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[] From 9454c9e35d1e074340fe3a72c1b3b18c500d9626 Mon Sep 17 00:00:00 2001 From: Deb Adair Date: Fri, 5 Apr 2019 09:28:53 -0700 Subject: [PATCH 2/5] [DOCS] Adding ILM settings file --- docs/reference/settings/ilm-settings.asciidoc | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/reference/settings/ilm-settings.asciidoc diff --git a/docs/reference/settings/ilm-settings.asciidoc b/docs/reference/settings/ilm-settings.asciidoc new file mode 100644 index 0000000000000..db3f27756e0ed --- /dev/null +++ b/docs/reference/settings/ilm-settings.asciidoc @@ -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 <>. + +`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. Required if the specified +policy contains a rollover action. When the index rolls over, the alias is +updated to reflect that the index is no longer the +<>. From c437a12144af6d818e264a8d73a456ccd479e9dd Mon Sep 17 00:00:00 2001 From: Deb Adair Date: Fri, 5 Apr 2019 15:28:03 -0700 Subject: [PATCH 3/5] [DOCS] Moved the ILM settings to a separate section --- docs/reference/index-modules.asciidoc | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/reference/index-modules.asciidoc b/docs/reference/index-modules.asciidoc index ac9df3db0d4d4..7848a48fa58f9 100644 --- a/docs/reference/index-modules.asciidoc +++ b/docs/reference/index-modules.asciidoc @@ -256,10 +256,6 @@ Other index settings are available in index modules: Settings to define analyzers, tokenizers, token filters and character filters. -[xpack]#<>#:: - - Specify the lifecycle policy and rollover alias for an index. - <>:: Control over where, when, and how shards are allocated to nodes. @@ -289,6 +285,12 @@ Other index settings are available in index modules: Control over the transaction log and background flush operations. +[float] +=== [xpack]#{xpack} index settings# + +<>:: + + Specify the lifecycle policy and rollover alias for an index. -- include::index-modules/analysis.asciidoc[] From 6dcead9e42c75bb55e41c8edef086b80d84b6697 Mon Sep 17 00:00:00 2001 From: Deb Adair Date: Fri, 5 Apr 2019 16:06:28 -0700 Subject: [PATCH 4/5] [DOCS] Linked to the rollover docs. --- docs/reference/settings/ilm-settings.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/settings/ilm-settings.asciidoc b/docs/reference/settings/ilm-settings.asciidoc index db3f27756e0ed..56b31560fc617 100644 --- a/docs/reference/settings/ilm-settings.asciidoc +++ b/docs/reference/settings/ilm-settings.asciidoc @@ -12,4 +12,4 @@ The name of the policy to use to manage the index. The index alias to update when the index rolls over. Required if the specified policy 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 <>. From 9d192eb997f41773275a67844438a6cce548cc78 Mon Sep 17 00:00:00 2001 From: Deb Adair Date: Fri, 5 Apr 2019 16:22:01 -0700 Subject: [PATCH 5/5] [DOCS] Tweaked the "required" wording. --- docs/reference/settings/ilm-settings.asciidoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/settings/ilm-settings.asciidoc b/docs/reference/settings/ilm-settings.asciidoc index 56b31560fc617..7de2036273b99 100644 --- a/docs/reference/settings/ilm-settings.asciidoc +++ b/docs/reference/settings/ilm-settings.asciidoc @@ -9,7 +9,7 @@ templates. For more information, see <>. 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. Required if the specified -policy 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 <>. +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 <>.