Skip to content

Commit

Permalink
Document manual steps in ILM delete phase (#111734)
Browse files Browse the repository at this point in the history
Spells out some cases in which ILM doesn't delete the underlying
searchable snapshot and instructs users to delete them manually instead.

Co-authored-by: shainaraskas <[email protected]>
  • Loading branch information
DaveCTurner and shainaraskas authored Aug 13, 2024
1 parent 4f70047 commit 664573c
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/reference/ilm/actions/ilm-delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ Deletes the searchable snapshot created in a previous phase.
Defaults to `true`.
This option is applicable when the <<ilm-searchable-snapshot,searchable
snapshot>> action is used in any previous phase.
+
If you set this option to `false`, use the <<delete-snapshot-api,Delete
snapshots API>> to remove {search-snaps} from your snapshot repository when
they are no longer needed.
+
If you manually delete an index before the {ilm-cap} delete phase runs, then
{ilm-init} will not delete the underlying {search-snap}. Use the
<<delete-snapshot-api,Delete snapshots API>> to remove the {search-snap} from
your snapshot repository when it is no longer needed.
+
See <<searchable-snapshots-reliability,Reliability of {search-snaps}>> for
further information about deleting {search-snaps}.

WARNING: If a policy with a searchable snapshot action is applied on an existing searchable snapshot index,
the snapshot backing this index will NOT be deleted because it was not created by this policy. If you want
Expand Down

0 comments on commit 664573c

Please sign in to comment.