From 87dfaf2eb9d345bb5d4508248c46cc713df75e64 Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Wed, 3 Apr 2024 14:14:13 +0200 Subject: [PATCH] [doc-units] document how interval value is parsed --- doc/book/reference-manual/configuration.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/book/reference-manual/configuration.md b/doc/book/reference-manual/configuration.md index 1ac2051e..39936094 100644 --- a/doc/book/reference-manual/configuration.md +++ b/doc/book/reference-manual/configuration.md @@ -376,10 +376,12 @@ if geographical replication is used. If this value is set, Garage will automatically take a snapshot of the metadata DB file at a regular interval and save it in the metadata directory. -This can allow to recover from situations where the metadata DB file is corrupted, -for instance after an unclean shutdown. -See [this page](@/documentation/operations/recovering.md#corrupted_meta) for details. +This parameter can take any duration string that can be parsed by +the [`parse_duration`](https://docs.rs/parse_duration/latest/parse_duration/#syntax) crate. +Snapshots can allow to recover from situations where the metadata DB file is +corrupted, for instance after an unclean shutdown. See [this +page](@/documentation/operations/recovering.md#corrupted_meta) for details. Garage keeps only the two most recent snapshots of the metadata DB and deletes older ones automatically.