@@ -112,6 +112,7 @@ policy definition.
112
112
- <<ilm-unfollow-action,Unfollow>>
113
113
- <<ilm-allocate-action,Allocate>>
114
114
- <<ilm-freeze-action,Freeze>>
115
+ - <<ilm-searchable-snapshot-action, Searchable Snapshot>>
115
116
* Delete
116
117
- <<ilm-wait-for-snapshot-action,Wait For Snapshot>>
117
118
- <<ilm-delete-action,Delete>>
@@ -271,7 +272,15 @@ Phases allowed: delete.
271
272
272
273
The Delete Action does just that, it deletes the index.
273
274
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
+ |======
275
284
276
285
[source,console]
277
286
--------------------------------------------------
@@ -585,6 +594,43 @@ The above example illustrates a policy which attempts to delete an
585
594
index one day after the index has been rolled over. It does not
586
595
delete the index one day after it has been created.
587
596
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
+ --------------------------------------------------
588
634
[[ilm-set-priority-action]]
589
635
==== Set Priority
590
636
0 commit comments