From d65ed5649ad42d7f534064dabf015f14d338c57d Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 26 Oct 2021 17:22:50 -0400 Subject: [PATCH] [DOCS] Clarify `max_count` only counts successful snapshot attempts (#79749) 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. --- docs/reference/slm/apis/slm-put.asciidoc | 6 ++++-- .../snapshot-restore/apis/get-snapshot-api.asciidoc | 1 + 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/reference/slm/apis/slm-put.asciidoc b/docs/reference/slm/apis/slm-put.asciidoc index 934f84f8498a..dd8940402b94 100644 --- a/docs/reference/slm/apis/slm-put.asciidoc +++ b/docs/reference/slm/apis/slm-put.asciidoc @@ -89,8 +89,10 @@ deletion. {slm-init} deletes expired snapshots based on the `max_count`:: (Optional, integer) Maximum number of snapshots to retain, even if the snapshots have not yet -expired. If the number of snapshots in the repository exceeds this limit, the -policy retains the most recent snapshots and deletes older snapshots. +expired. If the number of snapshots in the repository exceeds this limit, the +policy retains the most recent snapshots and deletes older snapshots. This limit +only includes snapshots with a <> of +`SUCCESS`. + NOTE: The maximum number of snapshots in a repository should not exceed `200`. This ensures that the snapshot repository metadata does not 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 diff --git a/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc b/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc index 621161d80d6b..b951dae30bea 100644 --- a/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc +++ b/docs/reference/snapshot-restore/apis/get-snapshot-api.asciidoc @@ -283,6 +283,7 @@ Number of shards that were successfully included in the snapshot. Number of shards that failed to be included in the snapshot. ==== +[[get-snapshot-api-response-state]] `state`:: + --