From 1defe919bc028d9874c702b488ccc8e2fd856436 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Mon, 15 Nov 2021 17:35:48 -0500 Subject: [PATCH 1/5] [DOCS] Remove 200 snapshot soft limit for repo --- docs/Versions.asciidoc | 4 ---- docs/reference/slm/apis/slm-put.asciidoc | 4 ---- .../snapshot-restore/take-snapshot.asciidoc | 15 ++------------- 3 files changed, 2 insertions(+), 21 deletions(-) diff --git a/docs/Versions.asciidoc b/docs/Versions.asciidoc index a20fce6f8ea96..2038cc5e2efd7 100644 --- a/docs/Versions.asciidoc +++ b/docs/Versions.asciidoc @@ -68,7 +68,3 @@ ifeval::["{source_branch}"=="7.x"] :apm-server-ref-v: {apm-server-ref-m} :apm-overview-ref-v: {apm-overview-ref-m} endif::[] - -// Max recommended snapshots in a snapshot repo. -// Used in the snapshot/restore docs. -:max-snapshot-count: 200 diff --git a/docs/reference/slm/apis/slm-put.asciidoc b/docs/reference/slm/apis/slm-put.asciidoc index 6a736c7ca6d03..8e23828eeb6a1 100644 --- a/docs/reference/slm/apis/slm-put.asciidoc +++ b/docs/reference/slm/apis/slm-put.asciidoc @@ -86,7 +86,6 @@ Time period after which a snapshot is considered expired and eligible for deletion. {slm-init} deletes expired snapshots based on the <>. -// To update {max-snapshot-count}, see docs/Version.asciidoc `max_count`:: (Optional, integer) Maximum number of snapshots to retain, even if the snapshots have not yet @@ -94,9 +93,6 @@ 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: This value should not exceed {max-snapshot-count}. See -<>. `min_count`:: (Optional, integer) diff --git a/docs/reference/snapshot-restore/take-snapshot.asciidoc b/docs/reference/snapshot-restore/take-snapshot.asciidoc index 79de143b68993..b7e37b26ab79e 100644 --- a/docs/reference/snapshot-restore/take-snapshot.asciidoc +++ b/docs/reference/snapshot-restore/take-snapshot.asciidoc @@ -215,7 +215,7 @@ PUT _slm/policy/nightly-snapshots states, see <>. <6> Optional retention rules. This configuration keeps snapshots for 30 days, retaining at least 5 and no more than 50 snapshots regardless of age. See - <> and <>. + <>. [discrete] [[manually-run-slm-policy]] @@ -268,15 +268,6 @@ POST _slm/_execute_retention An {slm-init} policy's retention rules only apply to snapshots created using the policy. Other snapshots don't count toward the policy's retention limits. -[discrete] -[[snapshot-retention-limits]] -==== Snapshot retention limits - -While not a hard limit, a snapshot repository shouldn't contain more than -{max-snapshot-count} snapshots at a time. This ensures the repository's metadata -doesn't grow to a size that may destabilize the master node. We recommend you -set up your {slm-init} policy's retention rules to enforce this limit. - [discrete] [[manually-create-snapshot]] === Manually create a snapshot @@ -536,9 +527,7 @@ from a previous week or month. To fix this, you can create multiple {slm-init} policies with the same snapshot repository that run on different schedules. Since a policy's retention rules only apply to its snapshots, a policy won't delete a snapshot created by another -policy. However, you'll need to ensure the total number of snapshots in the -repository doesn't exceed the <>. +policy. For example, the following {slm-init} policy takes hourly snapshots with a maximum of 24 snapshots. The policy keeps its snapshots for one day. From 521dbb88b312b0d249904b13117e59b552f63cfc Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 16 Nov 2021 09:10:38 -0500 Subject: [PATCH 2/5] Re-add retention guidance --- .../snapshot-restore/take-snapshot.asciidoc | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/reference/snapshot-restore/take-snapshot.asciidoc b/docs/reference/snapshot-restore/take-snapshot.asciidoc index b7e37b26ab79e..40a01f7531343 100644 --- a/docs/reference/snapshot-restore/take-snapshot.asciidoc +++ b/docs/reference/snapshot-restore/take-snapshot.asciidoc @@ -215,7 +215,7 @@ PUT _slm/policy/nightly-snapshots states, see <>. <6> Optional retention rules. This configuration keeps snapshots for 30 days, retaining at least 5 and no more than 50 snapshots regardless of age. See - <>. + <> and <>. [discrete] [[manually-run-slm-policy]] @@ -268,6 +268,18 @@ POST _slm/_execute_retention An {slm-init} policy's retention rules only apply to snapshots created using the policy. Other snapshots don't count toward the policy's retention limits. +[discrete] +[[snapshot-retention-limits]] +==== Snapshot retention limits + +We recommend you include retention rules in your {slm-init} policy to delete +snapshots you no longer need. + +A snapshot repository can safely scale to thousands of snapshots. However, to +manage its metadata, a larger repository requires more memory and disk space on +the master node. Retention rules ensure a repository's metadata doesn't grow to +a size that may destabilize the master node. + [discrete] [[manually-create-snapshot]] === Manually create a snapshot From bbe793cf0d9f624c2dfb33baf3e913582f79d869 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 16 Nov 2021 09:35:53 -0500 Subject: [PATCH 3/5] reword --- docs/reference/snapshot-restore/take-snapshot.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/snapshot-restore/take-snapshot.asciidoc b/docs/reference/snapshot-restore/take-snapshot.asciidoc index 40a01f7531343..510d410649dec 100644 --- a/docs/reference/snapshot-restore/take-snapshot.asciidoc +++ b/docs/reference/snapshot-restore/take-snapshot.asciidoc @@ -276,7 +276,7 @@ We recommend you include retention rules in your {slm-init} policy to delete snapshots you no longer need. A snapshot repository can safely scale to thousands of snapshots. However, to -manage its metadata, a larger repository requires more memory and disk space on +manage its metadata, a large repository requires more memory and disk space on the master node. Retention rules ensure a repository's metadata doesn't grow to a size that may destabilize the master node. From d5d4d6b0664bc48ee3455f32382b24ee9359285d Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 16 Nov 2021 12:03:24 -0500 Subject: [PATCH 4/5] remove disk space --- docs/reference/snapshot-restore/take-snapshot.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/snapshot-restore/take-snapshot.asciidoc b/docs/reference/snapshot-restore/take-snapshot.asciidoc index 510d410649dec..de9a2df7ae899 100644 --- a/docs/reference/snapshot-restore/take-snapshot.asciidoc +++ b/docs/reference/snapshot-restore/take-snapshot.asciidoc @@ -276,9 +276,9 @@ We recommend you include retention rules in your {slm-init} policy to delete snapshots you no longer need. A snapshot repository can safely scale to thousands of snapshots. However, to -manage its metadata, a large repository requires more memory and disk space on -the master node. Retention rules ensure a repository's metadata doesn't grow to -a size that may destabilize the master node. +manage its metadata, a large repository requires more memory on the master node. +Retention rules ensure a repository's metadata doesn't grow to a size that may +destabilize the master node. [discrete] [[manually-create-snapshot]] From afc4c5ade62d411805b1908ba9d447d5a82fc255 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 16 Nov 2021 12:04:12 -0500 Subject: [PATCH 5/5] reword --- docs/reference/snapshot-restore/take-snapshot.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/snapshot-restore/take-snapshot.asciidoc b/docs/reference/snapshot-restore/take-snapshot.asciidoc index de9a2df7ae899..a4abef920d014 100644 --- a/docs/reference/snapshot-restore/take-snapshot.asciidoc +++ b/docs/reference/snapshot-restore/take-snapshot.asciidoc @@ -277,7 +277,7 @@ snapshots you no longer need. A snapshot repository can safely scale to thousands of snapshots. However, to manage its metadata, a large repository requires more memory on the master node. -Retention rules ensure a repository's metadata doesn't grow to a size that may +Retention rules ensure a repository's metadata doesn't grow to a size that could destabilize the master node. [discrete]