Skip to content

Commit eb64fb4

Browse files
authored
[DOCS] Clarify when SLM deletes expired snapshots (#73155) (#73160)
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.
1 parent 0035053 commit eb64fb4

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/reference/slm/apis/slm-put.asciidoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ Retention rules used to retain and delete snapshots created by the policy.
9494
`expire_after`::
9595
(Optional, <<time-units, time units>>)
9696
Time period after which a snapshot is considered expired and eligible for
97-
deletion.
97+
deletion. {slm-init} deletes expired snapshots based on the
98+
<<slm-retention-schedule,`slm.retention_schedule`>>.
9899
99100
`max_count`::
100101
(Optional, integer)
@@ -113,8 +114,8 @@ Minimum number of snapshots to retain, even if the snapshots have expired.
113114

114115
`schedule`::
115116
(Required, <<cron-expressions,Cron syntax>>)
116-
Periodic or absolute schedule at which the policy creates snapshots and deletes
117-
expired snapshots. Schedule changes to existing policies are applied immediately.
117+
Periodic or absolute schedule at which the policy creates snapshots. {slm-init}
118+
applies `schedule` changes immediately.
118119

119120
[[slm-api-put-example]]
120121
==== {api-examples-title}

0 commit comments

Comments
 (0)