|
@@ -4,16 +4,16 @@
|
|
|
|
|
|
Phases allowed: hot, cold, frozen.
|
|
|
|
|
|
-Takes a snapshot of the managed index in the configured repository
|
|
|
-and mounts it as a searchable snapshot.
|
|
|
-If the managed index is part of a <<data-streams, data stream>>,
|
|
|
-the mounted index replaces the original index in the data stream.
|
|
|
+Takes a snapshot of the managed index in the configured repository and mounts it
|
|
|
+as a <<searchable-snapshots,{search-snap}>>.
|
|
|
|
|
|
-To use the `searchable_snapshot` action in the `hot` phase, the `rollover`
|
|
|
-action *must* be present. If no rollover action is configured, {ilm-init}
|
|
|
-will reject the policy.
|
|
|
+In the frozen phase, the action mounts a <<partially-mounted,partially mounted
|
|
|
+index>>. In other phases, the action mounts a <<fully-mounted,fully mounted
|
|
|
+index>>. If the original index is part of a
|
|
|
+<<data-streams, data stream>>, the mounted index replaces the original index in
|
|
|
+the data stream.
|
|
|
|
|
|
-IMPORTANT: If the `searchable_snapshot` action is used in the `hot` phase the
|
|
|
+IMPORTANT: If the `searchable_snapshot` action is used in the hot phase the
|
|
|
subsequent phases cannot define any of the `shrink`, `forcemerge`, `freeze` or
|
|
|
`searchable_snapshot` (also available in the cold and frozen phases) actions.
|
|
|
|
|
@@ -35,9 +35,7 @@ To keep the snapshot, set `delete_searchable_snapshot` to `false` in the delete
|
|
|
|
|
|
`snapshot_repository`::
|
|
|
(Required, string)
|
|
|
-Specifies where to store the snapshot.
|
|
|
-See <<snapshots-register-repository>> for more information. In non-frozen phases the snapshot will
|
|
|
-be mounted as a `full_copy`, and in frozen phases mounted with the `shared_cache` storage type.
|
|
|
+<<snapshots-register-repository,Repository>> used to store the snapshot.
|
|
|
|
|
|
`force_merge_index`::
|
|
|
(Optional, Boolean)
|