Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.15] [DOCS] Remove soft limit for snapshot repositories (#80745) #80771

Merged
merged 1 commit into from
Nov 16, 2021
Merged

[7.15] [DOCS] Remove soft limit for snapshot repositories (#80745) #80771

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/reference/slm/apis/slm-put.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,12 @@ exist prior to the policy's creation. You can create a repository using the
(Optional, object)
Retention rules used to retain and delete snapshots created by the policy.
+
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 on the master node. Retention rules ensure a repository's
metadata doesn't grow to a size that could destabilize the master node.
+
.Properties of `retention`
[%collapsible%open]
====
Expand All @@ -93,10 +99,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 <<get-snapshot-api-response-state,`state`>> 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
other retention rules such that the repository size does not exceed `200` snapshots.

`min_count`::
(Optional, integer)
Expand Down