doc(setting): keep snapshots for the backup

Add a new global setting that allows users to keep the retain number of snapshots when the recurring job does a backup. Ref: 2997 Signed-off-by: James Lu <[email protected]>
longhorn · Nov 28, 2023 · 9738cee · 9738cee
1 parent 35fc225
commit 9738cee
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/content/docs/1.6.0/references/settings.md b/content/docs/1.6.0/references/settings.md
@@ -7,6 +7,7 @@ weight: 1
 - [General](#general)
   - [Node Drain Policy](#node-drain-policy)
   - [Automatically Cleanup System Generated Snapshot](#automatically-cleanup-system-generated-snapshot)
+  - [Automatically Clean up Outdated Snapshots of Recurring Backup Jobs](#automatically-clean-up-outdated-snapshots-of-recurring-backup-jobs)
   - [Automatically Delete Workload Pod when The Volume Is Detached Unexpectedly](#automatically-delete-workload-pod-when-the-volume-is-detached-unexpectedly)
   - [Automatic Salvage](#automatic-salvage)
   - [Concurrent Automatic Engine Upgrade Per Node Limit](#concurrent-automatic-engine-upgrade-per-node-limit)
@@ -101,6 +102,12 @@ Define the policy to use when a node with the last healthy replica of a volume i
 
 Longhorn will generate system snapshot during replica rebuild, and if a user doesn't setup a recurring snapshot schedule, all the system generated snapshots would be left in the replica, and user has to delete them manually, this setting allow Longhorn to automatically cleanup system generated snapshot before and after replica rebuild.
 
+#### Automatically Clean up Outdated Snapshots of Recurring Backup Jobs
+
+> Default: `true`
+
+When running a recurring backup job, Longhorn takes a new snapshot before creating the backup. Longhorn retains only the snapshot used by the last backup job even if the value of the retain parameter is not 1. This setting ensures that the retained snapshots directly correspond to the backups on the remote backup target.
+
 #### Automatically Delete Workload Pod when The Volume Is Detached Unexpectedly
 
 > Default: `true`
@@ -266,6 +273,7 @@ This information will help us gain insights how Longhorn is being used, which wi
     - Allow Recurring Job While Volume Is Detached
     - Allow Volume Creation With Degraded Availability
     - Automatically Cleanup System Generated Snapshot
+    - Automatically Clean up Outdated Snapshots of Recurring Backup Jobs
     - Automatically Delete Workload Pod when The Volume Is Detached Unexpectedly
     - Automatic Salvage
     - Backing Image Cleanup Wait Interval