Skip to content

Commit 521dbb8

Browse files
committed
Re-add retention guidance
1 parent 1defe91 commit 521dbb8

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/reference/snapshot-restore/take-snapshot.asciidoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ PUT _slm/policy/nightly-snapshots
215215
states, see <<back-up-specific-feature-state>>.
216216
<6> Optional retention rules. This configuration keeps snapshots for 30 days,
217217
retaining at least 5 and no more than 50 snapshots regardless of age. See
218-
<<slm-retention-task>>.
218+
<<slm-retention-task>> and <<snapshot-retention-limits>>.
219219

220220
[discrete]
221221
[[manually-run-slm-policy]]
@@ -268,6 +268,18 @@ POST _slm/_execute_retention
268268
An {slm-init} policy's retention rules only apply to snapshots created using the
269269
policy. Other snapshots don't count toward the policy's retention limits.
270270

271+
[discrete]
272+
[[snapshot-retention-limits]]
273+
==== Snapshot retention limits
274+
275+
We recommend you include retention rules in your {slm-init} policy to delete
276+
snapshots you no longer need.
277+
278+
A snapshot repository can safely scale to thousands of snapshots. However, to
279+
manage its metadata, a larger repository requires more memory and disk space on
280+
the master node. Retention rules ensure a repository's metadata doesn't grow to
281+
a size that may destabilize the master node.
282+
271283
[discrete]
272284
[[manually-create-snapshot]]
273285
=== Manually create a snapshot

0 commit comments

Comments
 (0)