diff --git a/barman/version.py b/barman/version.py index bb89f795d..5ac2cab3c 100644 --- a/barman/version.py +++ b/barman/version.py @@ -20,4 +20,4 @@ This module contains the current Barman version. """ -__version__ = "3.9.0" +__version__ = "3.10.0" diff --git a/doc/barman-cloud-backup-delete.1 b/doc/barman-cloud-backup-delete.1 index c5677438c..08088d8f6 100644 --- a/doc/barman-cloud-backup-delete.1 +++ b/doc/barman-cloud-backup-delete.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-BACKUP\-DELETE" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN\-CLOUD\-BACKUP\-DELETE" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-backup-delete.1.md b/doc/barman-cloud-backup-delete.1.md index adedf96fa..16d4e3c7f 100644 --- a/doc/barman-cloud-backup-delete.1.md +++ b/doc/barman-cloud-backup-delete.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-BACKUP-DELETE(1) Barman User manuals | Version 3.9.0 +% BARMAN-CLOUD-BACKUP-DELETE(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman-cloud-backup-keep.1 b/doc/barman-cloud-backup-keep.1 index dd7033480..395d81dbd 100644 --- a/doc/barman-cloud-backup-keep.1 +++ b/doc/barman-cloud-backup-keep.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-BACKUP\-DELETE" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN\-CLOUD\-BACKUP\-DELETE" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-backup-keep.1.md b/doc/barman-cloud-backup-keep.1.md index 257493b78..92c020422 100644 --- a/doc/barman-cloud-backup-keep.1.md +++ b/doc/barman-cloud-backup-keep.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-BACKUP-DELETE(1) Barman User manuals | Version 3.9.0 +% BARMAN-CLOUD-BACKUP-DELETE(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman-cloud-backup-list.1 b/doc/barman-cloud-backup-list.1 index a5dc7f4ab..1919aab59 100644 --- a/doc/barman-cloud-backup-list.1 +++ b/doc/barman-cloud-backup-list.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-BACKUP\-LIST" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN\-CLOUD\-BACKUP\-LIST" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-backup-list.1.md b/doc/barman-cloud-backup-list.1.md index 953963e60..41bd5a399 100644 --- a/doc/barman-cloud-backup-list.1.md +++ b/doc/barman-cloud-backup-list.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-BACKUP-LIST(1) Barman User manuals | Version 3.9.0 +% BARMAN-CLOUD-BACKUP-LIST(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman-cloud-backup-show.1 b/doc/barman-cloud-backup-show.1 index b8eb78c4c..5075341e2 100644 --- a/doc/barman-cloud-backup-show.1 +++ b/doc/barman-cloud-backup-show.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-BACKUP\-SHOW" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN\-CLOUD\-BACKUP\-SHOW" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-backup-show.1.md b/doc/barman-cloud-backup-show.1.md index c6e23edef..220a0cab7 100644 --- a/doc/barman-cloud-backup-show.1.md +++ b/doc/barman-cloud-backup-show.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-BACKUP-SHOW(1) Barman User manuals | Version 3.9.0 +% BARMAN-CLOUD-BACKUP-SHOW(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman-cloud-backup.1 b/doc/barman-cloud-backup.1 index 7a7509445..0d593bbbb 100644 --- a/doc/barman-cloud-backup.1 +++ b/doc/barman-cloud-backup.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-BACKUP" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN\-CLOUD\-BACKUP" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-backup.1.md b/doc/barman-cloud-backup.1.md index a49682cd0..48d201ca6 100644 --- a/doc/barman-cloud-backup.1.md +++ b/doc/barman-cloud-backup.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-BACKUP(1) Barman User manuals | Version 3.9.0 +% BARMAN-CLOUD-BACKUP(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman-cloud-check-wal-archive.1 b/doc/barman-cloud-check-wal-archive.1 index e0e86b712..88b38c878 100644 --- a/doc/barman-cloud-check-wal-archive.1 +++ b/doc/barman-cloud-check-wal-archive.1 @@ -1,7 +1,7 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-CHECK\-WAL\-ARCHIVE" "1" "October 3, 2023" "Barman User manuals" "Version -3.9.0" +.TH "BARMAN\-CLOUD\-CHECK\-WAL\-ARCHIVE" "1" "January 24, 2024" "Barman User manuals" "Version +3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-check-wal-archive.1.md b/doc/barman-cloud-check-wal-archive.1.md index 5a7d3b22c..4db3db38a 100644 --- a/doc/barman-cloud-check-wal-archive.1.md +++ b/doc/barman-cloud-check-wal-archive.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1) Barman User manuals | Version 3.9.0 +% BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman-cloud-restore.1 b/doc/barman-cloud-restore.1 index 5b9737055..765611252 100644 --- a/doc/barman-cloud-restore.1 +++ b/doc/barman-cloud-restore.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-RESTORE" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN\-CLOUD\-RESTORE" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-restore.1.md b/doc/barman-cloud-restore.1.md index 691ab2979..46fadccd3 100644 --- a/doc/barman-cloud-restore.1.md +++ b/doc/barman-cloud-restore.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-RESTORE(1) Barman User manuals | Version 3.9.0 +% BARMAN-CLOUD-RESTORE(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman-cloud-wal-archive.1 b/doc/barman-cloud-wal-archive.1 index 2641e2375..3cda8ca1e 100644 --- a/doc/barman-cloud-wal-archive.1 +++ b/doc/barman-cloud-wal-archive.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-WAL\-ARCHIVE" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN\-CLOUD\-WAL\-ARCHIVE" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-wal-archive.1.md b/doc/barman-cloud-wal-archive.1.md index e22b4c543..b54e5aa34 100644 --- a/doc/barman-cloud-wal-archive.1.md +++ b/doc/barman-cloud-wal-archive.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-WAL-ARCHIVE(1) Barman User manuals | Version 3.9.0 +% BARMAN-CLOUD-WAL-ARCHIVE(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman-cloud-wal-restore.1 b/doc/barman-cloud-wal-restore.1 index 2afe97912..0054faaa5 100644 --- a/doc/barman-cloud-wal-restore.1 +++ b/doc/barman-cloud-wal-restore.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-CLOUD\-WAL\-RESTORE" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN\-CLOUD\-WAL\-RESTORE" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-cloud-wal-restore.1.md b/doc/barman-cloud-wal-restore.1.md index 650ab0971..7675e3b26 100644 --- a/doc/barman-cloud-wal-restore.1.md +++ b/doc/barman-cloud-wal-restore.1.md @@ -1,6 +1,6 @@ -% BARMAN-CLOUD-WAL-RESTORE(1) Barman User manuals | Version 3.9.0 +% BARMAN-CLOUD-WAL-RESTORE(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman-wal-archive.1 b/doc/barman-wal-archive.1 index a39cb30dc..04f3ab60a 100644 --- a/doc/barman-wal-archive.1 +++ b/doc/barman-wal-archive.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-WAL\-ARCHIVE" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN\-WAL\-ARCHIVE" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-wal-archive.1.md b/doc/barman-wal-archive.1.md index 5db042c92..a336a5be5 100644 --- a/doc/barman-wal-archive.1.md +++ b/doc/barman-wal-archive.1.md @@ -1,6 +1,6 @@ -% BARMAN-WAL-ARCHIVE(1) Barman User manuals | Version 3.9.0 +% BARMAN-WAL-ARCHIVE(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman-wal-restore.1 b/doc/barman-wal-restore.1 index 4ce474e18..a1a9669a2 100644 --- a/doc/barman-wal-restore.1 +++ b/doc/barman-wal-restore.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN\-WAL\-RESTORE" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN\-WAL\-RESTORE" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP diff --git a/doc/barman-wal-restore.1.md b/doc/barman-wal-restore.1.md index 25f658f46..1b6866b83 100644 --- a/doc/barman-wal-restore.1.md +++ b/doc/barman-wal-restore.1.md @@ -1,6 +1,6 @@ -% BARMAN-WAL-RESTORE(1) Barman User manuals | Version 3.9.0 +% BARMAN-WAL-RESTORE(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 # NAME diff --git a/doc/barman.1 b/doc/barman.1 index 86dba4daf..a59842d77 100644 --- a/doc/barman.1 +++ b/doc/barman.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN" "1" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP @@ -239,6 +239,27 @@ Nagios plugin compatible output .RE .RE .TP +.B config\-switch \f[I]SERVER_NAME\f[] \f[I]MODEL_NAME\f[] +Apply a set of configuration overrides defined in the model +\f[C]MODEL_NAME\f[] to the Barman server \f[C]SERVER_NAME\f[]. +The final configuration is composed of the server configuration plus the +overrides defined in the given model. +Note: there can only be at most one model active at a time for a given +server. +config\-update \f[I]JSON_CHANGES\f[] +.RS +.RE +Create or update configuration of servers and/or models in Barman. +\f[C]JSON_CHANGES\f[] should be a JSON string containing an array of +documents. +Each document must contain the \f[C]scope\f[] key, which can be either +\f[C]server\f[] or \f[C]model\f[], and either the \f[C]server_name\f[] +or \f[C]model_name\f[] key, depending on the value of \f[C]scope\f[]. +Besides that, other keys are expected to be Barman configuration options +along with their desired values. +.RS +.RE +.TP .B cron Perform maintenance tasks, such as enforcing retention policies or WAL files management. @@ -404,6 +425,12 @@ Show all the configured servers, and their descriptions. .RS .RE .TP +.B lock\-directory\-cleanup +Automatically cleans up the barman_lock_directory from unused lock +files. +.RS +.RE +.TP .B put\-wal \f[I][OPTIONS]\f[] \f[I]SERVER_NAME\f[] Receive a WAL file from a remote server and securely store it into the \f[C]SERVER_NAME\f[] incoming directory. @@ -695,6 +722,17 @@ pg_receivewal .IP \[bu] 2 \f[I]all\f[]: any streaming client (default) .RE +.TP +.B \-\-source \f[I]SOURCE_TYPE\f[] +Possible values for SOURCE_TYPE are: +.RS +.IP \[bu] 2 +\f[I]backup\-host\f[]: list clients using the backup conninfo for a +server (default) +.IP \[bu] 2 +\f[I]wal\-host\f[]: list clients using the WAL streaming conninfo for a +server +.RE .RE .TP .B show\-backup \f[I]SERVER_NAME\f[] \f[I]BACKUP_ID\f[] diff --git a/doc/barman.1.d/00-header.md b/doc/barman.1.d/00-header.md index 9dc722941..faf682a09 100644 --- a/doc/barman.1.d/00-header.md +++ b/doc/barman.1.d/00-header.md @@ -1,3 +1,3 @@ -% BARMAN(1) Barman User manuals | Version 3.9.0 +% BARMAN(1) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 diff --git a/doc/barman.5 b/doc/barman.5 index bc1906d17..8088008e7 100644 --- a/doc/barman.5 +++ b/doc/barman.5 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.2.1 .\" -.TH "BARMAN" "5" "October 3, 2023" "Barman User manuals" "Version 3.9.0" +.TH "BARMAN" "5" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP @@ -68,6 +68,8 @@ activating the server. This will avoid spamming the Barman logs with errors during the initial setup. .RS +.PP +Scope: Server/Model. .RE .TP .B archiver @@ -84,8 +86,9 @@ set, Barman will automatically set this option to \f[C]true\f[]. This is in order to maintain parity with deprecated behaviour where \f[C]archiver\f[] would be enabled by default. This behaviour will be removed from the next major Barman version. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B archiver_batch_size @@ -97,8 +100,9 @@ When batch processing is activated, the \f[C]archive\-wal\f[] process would limit itself to maximum \f[C]archiver_batch_size\f[] WAL segments per single run. Integer. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B autogenerate_manifest @@ -113,19 +117,24 @@ postgesql documentation, and is compatible with the \f[C]pg_verifybackup\f[] tool. The option is ignored if the backup method is not rsync. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B aws_profile The name of the AWS profile to use when authenticating with AWS (e.g. INI section in AWS credentials file). -Global/Server. -aws_region .RS +.PP +Scope: Global/Server/Model. .RE +.TP +.B aws_region The name of the AWS region containing the EC2 VM and storage volumes defined by \f[C]snapshot_instance\f[] and \f[C]snapshot_disks\f[]. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B azure_credential @@ -133,30 +142,33 @@ The credential type (either \f[C]azure\-cli\f[] or \f[C]managed\-identity\f[]) to use when authenticating with Azure. If this is omitted then the default Azure authentication flow will be used. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B azure_resource_group The name of the Azure resource group to which the compute instance and disks defined by \f[C]snapshot_instance\f[] and \f[C]snapshot_disks\f[] belong. -Global/Server. Required when the \f[C]snapshot\f[] value is specified for \f[C]backup_method\f[] and \f[C]snapshot_provider\f[] is set to \f[C]azure\f[]. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B azure_subscription_id The ID of the Azure subscription which owns the instance and storage volumes defined by \f[C]snapshot_instance\f[] and \f[C]snapshot_disks\f[]. -Global/Server. Required when the \f[C]snapshot\f[] value is specified for \f[C]backup_method\f[] and \f[C]snapshot_provider\f[] is set to \f[C]azure\f[]. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B backup_compression @@ -170,10 +182,11 @@ compression algorithm is available on the Barman server (at backup time) and the PostgreSQL server (at recovery time). Note that the \f[C]lz4\f[] and \f[C]zstd\f[] algorithms require PostgreSQL 15 (beta) or later. -Global/Server. Note that \f[C]none\f[] compression will create an archive not compressed. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B backup_compression_format @@ -185,8 +198,9 @@ The value \f[C]plain\f[] can only be used if the server is running PostgreSQL 15 or later \f[I]and\f[] if \f[C]backup_compression_location\f[] is \f[C]server\f[]. Only supported when \f[C]backup_method\ =\ postgres\f[]. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B backup_compression_level @@ -195,8 +209,9 @@ compressing backups. Allowed values depend on the compression algorithm specified by \f[C]backup_compression\f[]. Only supported when \f[C]backup_method\ =\ postgres\f[]. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B backup_compression_location @@ -204,8 +219,9 @@ The location (either \f[C]client\f[] or \f[C]server\f[]) where compression should be performed during the backup. The value \f[C]server\f[] is only allowed if the server is running PostgreSQL 15 or later. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B backup_compression_workers @@ -214,12 +230,15 @@ Only supported when \f[C]backup_compression\ =\ zstd\f[] is set. Default value is 0. In this case default compression behavior will be used. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B backup_directory Directory where backup data for a server will be placed. -Server. .RS +.PP +Scope: Server. .RE .TP .B backup_method @@ -235,8 +254,9 @@ If set to \f[C]snapshot\f[], barman will use the API for the cloud provider defined in the \f[C]snapshot_provider\f[] option to create snapshots of disks specified in the \f[C]snapshot_disks\f[] option and save only the backup label and metadata to its own storage. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B backup_options @@ -264,50 +284,57 @@ backup. .PP Note that \f[C]exclusive_backup\f[] and \f[C]concurrent_backup\f[] are mutually exclusive. -Global/Server. +.PP +Scope: Global/Server/Model. .RE .TP .B bandwidth_limit This option allows you to specify a maximum transfer rate in kilobytes per second. A value of zero specifies no limit (default). -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B barman_home Main data directory for Barman. -Global. .RS +.PP +Scope: Global. .RE .TP .B barman_lock_directory Directory for locks. Default: \f[C]%(barman_home)s\f[]. -Global. .RS +.PP +Scope: Global. .RE .TP .B basebackup_retry_sleep Number of seconds of wait after a failed copy, before retrying Used during both backup and recovery operations. Positive integer, default 30. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B basebackup_retry_times Number of retries of base backup copy, after an error. Used during both backup and recovery operations. Positive integer, default 0. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B basebackups_directory Directory where base backups will be placed. -Server. .RS +.PP +Scope: Server. .RE .TP .B check_timeout @@ -315,8 +342,22 @@ Maximum execution time, in seconds per server, for a barman check command. Set to 0 to disable the timeout. Positive integer, default 30. -Global/Server. .RS +.PP +Scope: Global/Server/Model. +.RE +.TP +.B cluster +Name of the Barman cluster associated with a Barman server or model. +Used by Barman to group servers and configuration models that can be +applied to them. +Can be omitted for servers, in which case it defaults to the server +name. +Must be set for configuration models, so Barman knows the set of servers +which can apply a given model. +.RS +.PP +Scope: Server/Model. .RE .TP .B compression @@ -326,8 +367,23 @@ installed on the system), \f[C]bzip2\f[] (requires \f[C]bzip2\f[]), \f[C]pigz\f[] (requires \f[C]pigz\f[]), \f[C]pygzip\f[] (Python\[aq]s internal gzip compressor) and \f[C]pybzip2\f[] (Python\[aq]s internal bzip2 compressor). -Global/Server. .RS +.PP +Scope: Global/Server/Model. +.RE +.TP +.B config_changes_queue +Barman uses a queue to apply configuration changes requested through +\f[C]barman\ config\-update\f[] command. +This allows it to serialize multiple requests of configuration changes, +and also retry an operation which has been abruptly terminated. +This configuration option allows you to specify where in the filesystem +the queue should be written. +By default Barman writes to a file named \f[C]cfg_changes.queue\f[] +under \f[C]barman_home\f[]. +.RS +.PP +Scope: global. .RE .TP .B conninfo @@ -336,8 +392,9 @@ This is a libpq connection string, consult the PostgreSQL manual (https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING) for more information. Commonly used keys are: host, hostaddr, port, dbname, user, password. -Server. .RS +.PP +Scope: Server/Model. .RE .TP .B create_slot @@ -345,14 +402,16 @@ When set to \f[C]auto\f[] and \f[C]slot_name\f[] is defined, Barman automatically attempts to create the replication slot if not present. When set to \f[C]manual\f[] (default), the replication slot needs to be manually created. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B custom_compression_filter Customised compression algorithm applied to WAL files. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B custom_compression_magic @@ -364,21 +423,24 @@ been pre\-compressed with that compression. If you do not configure this then custom compression will still be applied but any pre\-compressed WAL files will be compressed again during WAL archive. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B custom_decompression_filter Customised decompression algorithm applied to compressed WAL files; this must match the compression algorithm. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B description A human readable description of a server. -Server. .RS +.PP +Scope: Server/Model. .RE .TP .B errors_directory @@ -386,6 +448,8 @@ Directory that contains WAL files that contain an error; usually this is related to a conflict with an existing WAL file (e.g. a WAL file that has been archived after a streamed one). .RS +.PP +Scope: Server. .RE .TP .B forward_config_path @@ -397,26 +461,30 @@ option and your configuration is in the same place on both the passive and primary barman servers. Defaults to false. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B gcp_project The ID of the GCP project which owns the instance and storage volumes defined by \f[C]snapshot_instance\f[] and \f[C]snapshot_disks\f[]. -Global/Server. Required when the \f[C]snapshot\f[] value is specified for \f[C]backup_method\f[] and \f[C]snapshot_provider\f[] is set to \f[C]gcp\f[]. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B gcp_zone The name of the availability zone where the compute instance and disks to be backed up in a snapshot backup are located. -Server. Required when the \f[C]snapshot\f[] value is specified for \f[C]backup_method\f[] and \f[C]snapshot_provider\f[] is set to \f[C]gcp\f[]. .RS +.PP +Scope: Server/Model. .RE .TP .B immediate_checkpoint @@ -428,15 +496,17 @@ setting on the PostgreSQL server. If set to \f[C]true\f[], an immediate checkpoint will be requested, meaning that PostgreSQL will complete the checkpoint as soon as possible. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B incoming_wals_directory Directory where incoming WAL files are archived into. Requires \f[C]archiver\f[] to be enabled. -Server. .RS +.PP +Scope: Server. .RE .TP .B last_backup_maximum_age @@ -447,8 +517,9 @@ If empty (default), latest backup is always considered valid. Syntax for this option is: "i (DAYS | WEEKS | MONTHS)" where i is an integer greater than zero, representing the number of days | weeks | months of the time frame. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B last_backup_minimum_size @@ -461,8 +532,9 @@ Syntax for this option is: "i (k|Ki|M|Mi|G|Gi|T|Ti)" where i is an integer greater than zero, with an optional SI or IEC suffix. k=kilo=1000, Ki=Kibi=1024 and so forth. Note that the suffix is case\-sensitive. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B last_wal_maximum_age @@ -472,53 +544,80 @@ If the latest WAL file is older than the time frame, barman check command will report an error to the user. If empty (default), the age of the WAL files is not checked. Syntax is the same as last_backup_maximum_age (above). -Global/Server. -log_file .RS +.PP +Scope: Global/Server/Model. +.RE +.TP +.B lock_directory_cleanup +enables automatic cleaning up of the \f[C]barman_lock_directory\f[] from +unused lock files. +.RS +.PP +Scope: Global. .RE +.TP +.B log_file Location of Barman\[aq]s log file. -Global. .RS +.PP +Scope: Global. .RE .TP .B log_level Level of logging (DEBUG, INFO, WARNING, ERROR, CRITICAL). -Global. .RS +.PP +Scope: Global. .RE .TP .B max_incoming_wals_queue Maximum number of WAL files in the incoming queue (in both streaming and archiving pools) that are allowed before barman check returns an error (that does not block backups). -Global/Server. Default: None (disabled). .RS +.PP +Scope: Global/Server/Model. .RE .TP .B minimum_redundancy Minimum number of backups to be retained. Default 0. -Global/Server. .RS +.PP +Scope: Global/Server/Model. +.RE +.TP +.B model +By default any section configured in the Barman configuration files +define the configuration for a Barman server. +If you set \f[C]model\ =\ true\f[] in a section, that turns that section +into a configuration model for a given \f[C]cluster\f[]. +Cannot be set as \f[C]false\f[]. +.RS +.PP +Scope: Model. .RE .TP .B network_compression This option allows you to enable data compression for network transfers. If set to \f[C]false\f[] (default), no compression is used. If set to \f[C]true\f[], compression is enabled, reducing network usage. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B parallel_jobs This option controls how many parallel workers will copy files during a backup or recovery command. Default 1. -Global/Server. For backup purposes, it works only when \f[C]backup_method\f[] is \f[C]rsync\f[]. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B parallel_jobs_start_batch_period @@ -526,12 +625,16 @@ The time period in seconds over which a single batch of jobs will be started. Default: 1 second. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B parallel_jobs_start_batch_size Maximum number of parallel jobs to start in a single batch. Default: 10 jobs. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B path_prefix @@ -539,8 +642,9 @@ One or more absolute paths, separated by colon, where Barman looks for executable files. The paths specified in \f[C]path_prefix\f[] are tried before the ones specified in \f[C]PATH\f[] environment variable. -Global/server. .RS +.PP +Scope: Global/server/Model. .RE .TP .B post_archive_retry_script @@ -550,15 +654,17 @@ of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or an ABORT_STOP (63) code. In a post archive scenario, ABORT_STOP has currently the same effects as ABORT_CONTINUE. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B post_archive_script Hook script launched after a WAL file is archived by maintenance, after \[aq]post_archive_retry_script\[aq]. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B post_backup_retry_script @@ -568,15 +674,17 @@ of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or an ABORT_STOP (63) code. In a post backup scenario, ABORT_STOP has currently the same effects as ABORT_CONTINUE. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B post_backup_script Hook script launched after a base backup, after \[aq]post_backup_retry_script\[aq]. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B post_delete_retry_script @@ -586,15 +694,17 @@ of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or an ABORT_STOP (63) code. In a post delete scenario, ABORT_STOP has currently the same effects as ABORT_CONTINUE. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B post_delete_script Hook script launched after the deletion of a backup, after \[aq]post_delete_retry_script\[aq]. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B post_recovery_retry_script @@ -604,15 +714,17 @@ of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or an ABORT_STOP (63) code. In a post recovery scenario, ABORT_STOP has currently the same effects as ABORT_CONTINUE. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B post_recovery_script Hook script launched after a recovery, after \[aq]post_recovery_retry_script\[aq]. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B post_wal_delete_retry_script @@ -622,15 +734,17 @@ of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or an ABORT_STOP (63) code. In a post delete scenario, ABORT_STOP has currently the same effects as ABORT_CONTINUE. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B post_wal_delete_script Hook script launched after the deletion of a WAL file, after \[aq]post_wal_delete_retry_script\[aq]. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B pre_archive_retry_script @@ -641,14 +755,16 @@ of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or an ABORT_STOP (63) code. Returning ABORT_STOP will propagate the failure at a higher level and interrupt the WAL archiving operation. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B pre_archive_script Hook script launched before a WAL file is archived by maintenance. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B pre_backup_retry_script @@ -659,14 +775,16 @@ of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or an ABORT_STOP (63) code. Returning ABORT_STOP will propagate the failure at a higher level and interrupt the backup operation. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B pre_backup_script Hook script launched before a base backup. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B pre_delete_retry_script @@ -677,14 +795,16 @@ of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or an ABORT_STOP (63) code. Returning ABORT_STOP will propagate the failure at a higher level and interrupt the backup deletion. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B pre_delete_script Hook script launched before the deletion of a backup. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B pre_recovery_retry_script @@ -695,14 +815,16 @@ of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or an ABORT_STOP (63) code. Returning ABORT_STOP will propagate the failure at a higher level and interrupt the recover operation. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B pre_recovery_script Hook script launched before a recovery. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B pre_wal_delete_retry_script @@ -713,14 +835,16 @@ of the script until this either returns a SUCCESS (0), an ABORT_CONTINUE (62) or an ABORT_STOP (63) code. Returning ABORT_STOP will propagate the failure at a higher level and interrupt the WAL file deletion. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B pre_wal_delete_script Hook script launched before the deletion of a WAL file. -Global/Server. .RS +.PP +Scope: Global/Server. .RE .TP .B primary_checkpoint_timeout @@ -737,6 +861,8 @@ The value of this option should be greater of the value of the .PP This option works only if \f[C]primary_conninfo\f[] option is set, and it is ignored otherwise. +.PP +Scope: Server/Model. .RE .TP .B primary_conninfo @@ -760,7 +886,8 @@ the PostgreSQL manual (https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING) for more information. Commonly used keys are: host, hostaddr, port, dbname, user, password. -Server. +.PP +Scope: Server/Model. .RE .TP .B primary_ssh_command @@ -771,6 +898,8 @@ If \f[C]primary_ssh_command\f[] is specified, Barman uses it to establish a connection with the primary server. Empty by default, it can also be set globally. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B recovery_options @@ -781,8 +910,9 @@ Currently only supports \f[C]get\-wal\f[]. uses the \f[C]barman\ get\-wal\f[] command to fetch WAL files directly from Barman\[aq]s archive of WALs. Comma separated list of values, default empty. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B recovery_staging_path @@ -797,8 +927,9 @@ The staging directory within the staging path will be removed at the end of the recovery process. This option is \f[I]required\f[] when recovering from compressed backups and has no effect otherwise. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B retention_policy @@ -812,19 +943,20 @@ a positive integer representing, specifically, the number of days, weeks or months to retain your backups. For more detailed information, refer to the official documentation. Default value is empty. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B retention_policy_mode Currently only "auto" is implemented. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B reuse_backup This option controls incremental backup support. -Global/Server. Possible values are: .RS .IP \[bu] 2 @@ -836,47 +968,54 @@ copy of the unchanged files (reduce backup time); \f[C]link\f[]: reuse the last available backup for a server and create a hard link of the unchanged files (reduce backup time and space). Requires operating system and file system support for hard links. +.PP +Scope: Global/Server/Model. .RE .TP .B slot_name Physical replication slot to be used by the \f[C]receive\-wal\f[] command when \f[C]streaming_archiver\f[] is set to \f[C]on\f[]. Default: None (disabled). -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B snapshot_disks A comma\-separated list of disks which should be included in a backup taken using cloud snapshots. -Server. Required when the \f[C]snapshot\f[] value is specified for \f[C]backup_method\f[]. .RS +.PP +Scope: Server/Model. .RE .TP .B snapshot_instance The name of the VM or compute instance where the storage volumes are attached. -Server. Required when the \f[C]snapshot\f[] value is specified for \f[C]backup_method\f[]. .RS +.PP +Scope: Server/Model. .RE .TP .B snapshot_provider The name of the cloud provider which should be used to create snapshots. -Global/Server. Required when the \f[C]snapshot\f[] value is specified for \f[C]backup_method\f[]. Supported values: \f[C]gcp\f[]. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B ssh_command Command used by Barman to login to the Postgres server via ssh. -Server. .RS +.PP +Scope: Server/Model. .RE .TP .B streaming_archiver @@ -896,8 +1035,9 @@ set, Barman will automatically set \f[C]archiver\f[] to \f[C]true\f[]. This is in order to maintain parity with deprecated behaviour where \f[C]archiver\f[] would be enabled by default. This behaviour will be removed from the next major Barman version. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B streaming_archiver_batch_size @@ -909,8 +1049,9 @@ When batch processing is activated, the \f[C]archive\-wal\f[] process would limit itself to maximum \f[C]streaming_archiver_batch_size\f[] WAL segments per single run. Integer. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B streaming_archiver_name @@ -919,32 +1060,36 @@ Identifier to be used as \f[C]application_name\f[] by the Only available with \f[C]pg_receivewal\f[] (or \f[C]pg_receivexlog\f[] >= 9.3). By default it is set to \f[C]barman_receive_wal\f[]. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B streaming_backup_name Identifier to be used as \f[C]application_name\f[] by the \f[C]pg_basebackup\f[] command. By default it is set to \f[C]barman_streaming_backup\f[]. -Global/Server. .RS +.PP +Scope: Global/Server/Model. .RE .TP .B streaming_conninfo Connection string used by Barman to connect to the Postgres server via streaming replication protocol. By default it is set to \f[C]conninfo\f[]. -Server. .RS +.PP +Scope: Server/Model. .RE .TP .B streaming_wals_directory Directory where WAL files are streamed from the PostgreSQL server to Barman. Requires \f[C]streaming_archiver\f[] to be enabled. -Server. .RS +.PP +Scope: Server. .RE .TP .B tablespace_bandwidth_limit @@ -952,21 +1097,48 @@ This option allows you to specify a maximum transfer rate in kilobytes per second, by specifying a comma separated list of tablespaces (pairs TBNAME:BWLIMIT). A value of zero specifies no limit (default). -Global/Server. .RS +.PP +Scope: Global/Server/Model. +.RE +.TP +.B wal_conninfo +A connection string which, if set, will be used by Barman to connect to +the Postgres server when checking the status of the replication slot +used for receiving WALs. +If left unset then Barman will use the connection string defined by +\f[C]wal_streaming_conninfo\f[]. +If \f[C]wal_conninfo\f[] is set but \f[C]wal_streaming_conninfo\f[] is +unset then \f[C]wal_conninfo\f[] will be ignored. +.RS +.PP +Scope: Server/Model. .RE .TP .B wal_retention_policy Policy for retention of archive logs (WAL files). Currently only "MAIN" is available. -Global/Server. .RS +.PP +Scope: Global/Server/Model. +.RE +.TP +.B wal_streaming_conninfo +A connection string which, if set, will be used by Barman to connect to +the Postgres server when receiving WAL segments via the streaming +replication protocol. +If left unset then Barman will use the connection string defined by +\f[C]streaming_conninfo\f[] for receiving WAL segments. +.RS +.PP +Scope: Server/Model. .RE .TP .B wals_directory Directory which contains WAL files. -Server. .RS +.PP +Scope: Server. .RE .SH HOOK SCRIPTS .PP diff --git a/doc/barman.5.d/00-header.md b/doc/barman.5.d/00-header.md index 985dab1a0..d8675fb2a 100644 --- a/doc/barman.5.d/00-header.md +++ b/doc/barman.5.d/00-header.md @@ -1,3 +1,3 @@ -% BARMAN(5) Barman User manuals | Version 3.9.0 +% BARMAN(5) Barman User manuals | Version 3.10.0 % EnterpriseDB -% October 3, 2023 +% January 24, 2024 diff --git a/doc/manual/00-head.en.md b/doc/manual/00-head.en.md index 8c52a6bad..5fdf07d39 100644 --- a/doc/manual/00-head.en.md +++ b/doc/manual/00-head.en.md @@ -1,6 +1,6 @@ % Barman Manual % EnterpriseDB UK Limited -% October 3, 2023 (3.9.0) +% January 24, 2024 (3.10.0) **Barman** (Backup and Recovery Manager) is an open-source administration tool for disaster recovery of PostgreSQL servers written in Python. It allows your organisation to perform remote backups of multiple servers in business critical environments to reduce risk and help DBAs during the recovery phase.