Skip to content

Commit 684afab

Browse files
authored
[DOCS] Clarify max_count only counts successful snapshot attempts (#79749) (#79871)
The create SLM policy API's `max_count` parameter limits the number of snapshots for a policy. Only successful snapshot attempts count toward this limit. Failed snapshot attempts do not.
1 parent cd94c34 commit 684afab

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,10 @@ deletion. {slm-init} deletes expired snapshots based on the
8989
`max_count`::
9090
(Optional, integer)
9191
Maximum number of snapshots to retain, even if the snapshots have not yet
92-
expired. If the number of snapshots in the repository exceeds this limit, the
93-
policy retains the most recent snapshots and deletes older snapshots.
92+
expired. If the number of snapshots in the repository exceeds this limit, the
93+
policy retains the most recent snapshots and deletes older snapshots. This limit
94+
only includes snapshots with a <<get-snapshot-api-response-state,`state`>> of
95+
`SUCCESS`.
9496
+
9597
NOTE: The maximum number of snapshots in a repository should not exceed `200`. This ensures that the snapshot repository metadata does not
9698
grow to a size which might destabilize the master node. If the `max_count` setting is not set, this limit should be enforced by configuring

docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,7 @@ Number of shards that were successfully included in the snapshot.
283283
Number of shards that failed to be included in the snapshot.
284284
====
285285

286+
[[get-snapshot-api-response-state]]
286287
`state`::
287288
+
288289
--

0 commit comments

Comments
 (0)