Add note in the manual about recovery near retention policy

This commit Closes#200. It is adding a note to the recovery section in the documentation manual alerting the user about the possibility of the backup getting obsolete while the recovery process is ongoing and what to do to prevent that. The team first thought about a solution that could handle this automatically but many arguments were against this, specially because it could introduce unwanted behaviour on recover and the fact that `keep` feature is there to help. References: BAR-222 Signed-off-by: Andre <[email protected]>
EnterpriseDB · Aug 23, 2024 · 5702196 · 5702196
1 parent db1336e
commit 5702196
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/manual/43-backup-commands.en.md b/doc/manual/43-backup-commands.en.md
@@ -198,6 +198,13 @@ command.
 
 The recovery command has several options that modify the command behavior.
 
+> **NOTE:**
+> If you’re not sure whether the backup can be automatically removed by
+> retention policies during recovery, avoid issuing the `recover` command
+> right away. Instead, first mark the backup with `keep` and specify the
+> `target`. Once the recovery process is complete, if you don’t want to
+> keep the backup beyond the retention policy, you can then release it.
+
 ### Remote recovery
 
 Add the `--remote-ssh-command <COMMAND>` option to the invocation