Skip to content

Clarify WAL retention policy documentation #1189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
puneetdixit200 wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −8
Open

Clarify WAL retention policy documentation #1189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions docs/faq/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,17 @@ less invasive than what is required for high availability.

**Can I define retention policies for my backups?**

Yes. Barman 1.2.0 introduced support for retention policies both for base backups and
WAL segments, for every server you have. You can specify a retention policy in the
server configuration file. Retention policies can be based on time
(e.g. ``RECOVERY WINDOW OF 30 DAYS``) or number of base backups
(e.g. ``REDUNDANCY 3``).
Yes. You can specify a retention policy in the server configuration file. The
``retention_policy`` option controls which base backups, and which WAL files required
by those backups, Barman retains. Retention policies can be based on time
(for example, ``RECOVERY WINDOW OF 30 DAYS``) or number of base backups
(for example, ``REDUNDANCY 3``).

Barman doesn't currently support an independent retention policy for WAL files. The
``wal_retention_policy`` option only supports ``main``, which means WAL retention
follows the main ``retention_policy`` setting. To keep WAL files for a longer
point-in-time recovery window, configure ``retention_policy`` for that window or manage
the extra WAL archive outside Barman.

**Does Barman guarantee data protection and security?**

Expand Down Expand Up @@ -242,4 +248,3 @@ Barman can take backups of your Postgres servers on Windows. The recovery part
is not supported. Additionally, Barman will have to run on a UNIX box.



6 changes: 4 additions & 2 deletions docs/user_guide/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1574,7 +1574,9 @@ Scope: Global / Server / Model.

**wal_retention_policy**

Policy for retaining WAL files. Currently only ``main`` is available.
Policy for retaining WAL files. Currently only ``main`` is available. With ``main``,
WAL retention follows the main ``retention_policy`` setting. Barman doesn't support a
separate WAL retention policy.

Scope: Global / Server / Model.

Expand Down Expand Up @@ -1855,4 +1857,4 @@ Benefits
You will not see any in place changes in the configuration file. The overrides are
applied internally and you can check the current server configuration by using the
command ``barman show-servers SERVER_NAME`` for the complete list of settings, or in
the ``barman diagnose`` output.
the ``barman diagnose`` output.