diff options
| author | Alex Auvolat <alex@adnab.me> | 2024-04-03 14:14:13 +0200 |
|---|---|---|
| committer | Alex Auvolat <alex@adnab.me> | 2024-04-03 14:14:13 +0200 |
| commit | 87dfaf2eb9d345bb5d4508248c46cc713df75e64 (patch) | |
| tree | c8fa65b829e897b27cec17c95128d98b31e4417c | |
| parent | ecf641d88c264f7278d13a6d988288feb24a5dfe (diff) | |
| download | garage-87dfaf2eb9d345bb5d4508248c46cc713df75e64.tar.gz garage-87dfaf2eb9d345bb5d4508248c46cc713df75e64.zip | |
[doc-units] document how interval value is parsed
| -rw-r--r-- | doc/book/reference-manual/configuration.md | 8 |
1 files 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. |