github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-24 15:17:30 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Clarify when SLM deletes expired snapshots (#73155)

Browse source 
Changes:
* Removes an error in the create SLM policy API's `schedule` parameter
  def. `schedule` is not used to delete expired snapshots.

* Updates the `expire_after` parameter def to mention the
  `slm.retention_schedule` cluster setting.
This commit is contained in:
James Rodewig 2021-05-17 10:02:08 -04:00 • committed by GitHub
parent d9b39d377e
commit 7b64caee16
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/reference/slm/apis/slm-put.asciidoc
View file

@ -94,7 +94,8 @@ Retention rules used to retain and delete snapshots created by the policy.
`expire_after`::
(Optional, <<time-units, time units>>)
Time period after which a snapshot is considered expired and eligible for
deletion.
deletion. {slm-init} deletes expired snapshots based on the
<<slm-retention-schedule,`slm.retention_schedule`>>.
`max_count`::
(Optional, integer)
@ -113,8 +114,8 @@ Minimum number of snapshots to retain, even if the snapshots have expired.
`schedule`::
(Required, <<cron-expressions,Cron syntax>>)
Periodic or absolute schedule at which the policy creates snapshots and deletes
expired snapshots. Schedule changes to existing policies are applied immediately.
Periodic or absolute schedule at which the policy creates snapshots. {slm-init}
applies `schedule` changes immediately.
[[slm-api-put-example]]
==== {api-examples-title}