mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 21:18:31 +00:00
8a662c7e62
* [DOCS] Rework conceptual info for ILM. (#52181) * [DOCS] Rework conceptual info for ILM. * Split the actions out of concepts. * Added xpack role to actions. Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review * Edit actions for consistency and add action template. (#55632) * Edit actions for consistency and add action template. * Update docs/reference/ilm/actions/ilm-readonly.asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review
40 lines
972 B
Plaintext
40 lines
972 B
Plaintext
[role="xpack"]
|
|
[[ilm-searchable-snapshot]]
|
|
=== Searchable snapshot
|
|
|
|
Phases allowed: cold.
|
|
|
|
Takes a snapshot of the managed index in the configured repository
|
|
and mounts it as a searchable snapshot.
|
|
|
|
By default, this snapshot is deleted by the <<ilm-delete-action, delete action>> in the delete phase.
|
|
To keep the snapshot, set `delete_searchable_snapshot` to `false` in the delete action.
|
|
|
|
[[ilm-searchable-snapshot-options]]
|
|
==== Options
|
|
|
|
`snapshot_repository`::
|
|
(Required, string)
|
|
Specifies where to store the snapshot.
|
|
See <<snapshots-register-repository>> for more information.
|
|
|
|
[[ilm-searchable-snapshot-ex]]
|
|
==== Examples
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ilm/policy/my_policy
|
|
{
|
|
"policy": {
|
|
"phases": {
|
|
"cold": {
|
|
"actions": {
|
|
"searchable_snapshot" : {
|
|
"snapshot_repository" : "backing_repo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|