From d7652963b1974778ff94a9c3a8876eb7e18d8b47 Mon Sep 17 00:00:00 2001 From: Gordon Brown Date: Fri, 30 Nov 2018 12:06:48 -0700 Subject: [PATCH] Add note about ILM and Snapshots (#36023) This commit documents how Index Lifecycle Management interacts with snapshot/restore, and documents a workaround for situations in which ILM should not immediately resume managing an index after it is restored. --- docs/reference/ilm/ilm-and-snapshots.asciidoc | 35 +++++++++++++++++++ docs/reference/ilm/index.asciidoc | 2 ++ 2 files changed, 37 insertions(+) create mode 100644 docs/reference/ilm/ilm-and-snapshots.asciidoc diff --git a/docs/reference/ilm/ilm-and-snapshots.asciidoc b/docs/reference/ilm/ilm-and-snapshots.asciidoc new file mode 100644 index 00000000000..847bf633788 --- /dev/null +++ b/docs/reference/ilm/ilm-and-snapshots.asciidoc @@ -0,0 +1,35 @@ +[role="xpack"] +[testenv="basic"] +[[index-lifecycle-and-snapshots]] +== Restoring Snapshots of Managed Indices + +beta[] + +When restoring a snapshot that contains indices managed by Index Lifecycle +Management, the lifecycle will automatically continue to execute after the +snapshot is restored. Notably, the `min_age` is relative to the original +creation or rollover of the index, rather than when the index was restored. For +example, a monthly index that is restored partway through its lifecycle after an +accidental deletion will be continue through its lifecycle as expected: The +index will be shrunk, reallocated to different nodes, or deleted on the same +schedule whether or not it has been restored from a snapshot. + +However, there may be cases where you need to restore an index from a snapshot, +but do not want it to automatically continue through its lifecycle, particularly +if the index would rapidly progress through lifecycle phases due to its age. For +example, you may wish to add or update documents in an index before it is marked +read only or shrunk, or prevent an index from automatically being deleted. + +To stop lifecycle policy execution on an index restored from a snapshot, before +restoring the snapshot, <> to allow the policy to be removed. + +For example, the following workflow can be used in the above situation to +prevent the execution of the lifecycle policy for an index: + +1. Pause execution of all lifecycle policies using the <> +2. Restore the snapshot. +3. Perform whatever operations you wish before resuming lifecycle execution, or + remove the lifecycle policy from the index using the + <> +4. Resume execution of lifecycle policies using the <> \ No newline at end of file diff --git a/docs/reference/ilm/index.asciidoc b/docs/reference/ilm/index.asciidoc index dcee0c06f42..6721abdd473 100644 --- a/docs/reference/ilm/index.asciidoc +++ b/docs/reference/ilm/index.asciidoc @@ -64,4 +64,6 @@ include::update-lifecycle-policy.asciidoc[] include::error-handling.asciidoc[] +include::ilm-and-snapshots.asciidoc[] + include::start-stop-ilm.asciidoc[]