浏览代码

[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.
James Rodewig 4 年之前
父节点
当前提交
7b64caee16
共有 1 个文件被更改,包括 4 次插入3 次删除
  1. 4 3
      docs/reference/slm/apis/slm-put.asciidoc

+ 4 - 3
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-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}