Skip to content

Commit 66f4433

Browse files
authored
ILM Initial documentation for searchable snapshots (#54727)
1 parent 34d3478 commit 66f4433

File tree

1 file changed

+47
-1
lines changed

1 file changed

+47
-1
lines changed

docs/reference/ilm/policy-definitions.asciidoc

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ policy definition.
112112
- <<ilm-unfollow-action,Unfollow>>
113113
- <<ilm-allocate-action,Allocate>>
114114
- <<ilm-freeze-action,Freeze>>
115+
- <<ilm-searchable-snapshot-action, Searchable Snapshot>>
115116
* Delete
116117
- <<ilm-wait-for-snapshot-action,Wait For Snapshot>>
117118
- <<ilm-delete-action,Delete>>
@@ -271,7 +272,15 @@ Phases allowed: delete.
271272

272273
The Delete Action does just that, it deletes the index.
273274

274-
This action does not have any options associated with it.
275+
[[ilm-delete-action-options]]
276+
.Delete
277+
[options="header"]
278+
|======
279+
| Name | Required | Default | Description
280+
| `delete_searchable_snapshot` | no | true | Deletes the searchable snapshot created in the cold phase, if a
281+
snapshot was created (ie. if the <<ilm-searchable-snapshot-action,
282+
Searchable Snapshot Action>> was used in the cold phase)
283+
|======
275284

276285
[source,console]
277286
--------------------------------------------------
@@ -585,6 +594,43 @@ The above example illustrates a policy which attempts to delete an
585594
index one day after the index has been rolled over. It does not
586595
delete the index one day after it has been created.
587596

597+
[[ilm-searchable-snapshot-action]]
598+
==== Searchable Snapshot
599+
600+
Phases allowed: cold.
601+
602+
This action takes a snapshot of the managed index in the configured repository
603+
and mounts it as a searchable snapshot.
604+
605+
[[ilm-searchable-snapshot-options]]
606+
.Searchable Snapshot Options
607+
[options="header"]
608+
|======
609+
| Name | Required | Default | Description
610+
| `snapshot_repository` | yes | - | Repository used to store the snapshot created by this action. The snapshot will be,
611+
by default, deleted by the <<ilm-delete-action, Delete Action>> in the delete phase, if
612+
configured, but the user can configure the <<ilm-delete-action, Delete Action>> to keep
613+
the snapshot using the `delete_searchable_snapshot` option.
614+
615+
|======
616+
617+
[source,console]
618+
--------------------------------------------------
619+
PUT _ilm/policy/my_policy
620+
{
621+
"policy": {
622+
"phases": {
623+
"cold": {
624+
"actions": {
625+
"searchable_snapshot" : {
626+
"snapshot_repository" : "backing_repo"
627+
}
628+
}
629+
}
630+
}
631+
}
632+
}
633+
--------------------------------------------------
588634
[[ilm-set-priority-action]]
589635
==== Set Priority
590636

0 commit comments

Comments
 (0)