From 7b64caee1602daf182327274ca55fa46b93d544f Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Mon, 17 May 2021 10:02:08 -0400 Subject: [PATCH] [DOCS] Clarify when SLM deletes expired snapshots (#73155) 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. --- docs/reference/slm/apis/slm-put.asciidoc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/reference/slm/apis/slm-put.asciidoc b/docs/reference/slm/apis/slm-put.asciidoc index 423b1bff33a0..7785c08d09f8 100644 --- a/docs/reference/slm/apis/slm-put.asciidoc +++ b/docs/reference/slm/apis/slm-put.asciidoc @@ -94,7 +94,8 @@ Retention rules used to retain and delete snapshots created by the policy. `expire_after`:: (Optional, <>) Time period after which a snapshot is considered expired and eligible for -deletion. +deletion. {slm-init} deletes expired snapshots based on the +<>. `max_count`:: (Optional, integer) @@ -113,8 +114,8 @@ Minimum number of snapshots to retain, even if the snapshots have expired. `schedule`:: (Required, <>) -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}