barman - Backup and Recovery Manager for PostgreSQL
Barman is an administration tool for disaster recovery of PostgreSQL servers written in Python and maintained by 2ndQuadrant. Barman can perform remote backups of multiple servers in business critical environments and helps DBAs during the recovery phase.
CONFIGURATION FILE LOCATIONS
The system-level Barman configuration file is located at
and is overridden on a per-user level by
CONFIGURATION FILE SYNTAX
The Barman configuration file is a plain INI file. There is a general section called [barman] and a section [servername] for each server you want to backup. Rows starting with ; are comments.
CONFIGURATION FILE DIRECTORY
Barman supports the inclusion of multiple configuration files, through the configuration_files_directory option. Included files must contain only server specifications, not global configurations. If the value of configuration_files_directory is a directory, Barman reads all files with .conf extension that exist in that folder. For example, if you set it to /etc/barman.d, you can specify your PostgreSQL servers placing each section in a separate .conf file inside the /etc/barman.d folder.
When set to true (default), the server is in full operational state. When set to false, the server can be used for diagnostics, but any operational command such as backup execution or WAL archiving is temporarily disabled. Setting active=false is a good practice when adding a new node to Barman. Server.
This option allows you to activate log file shipping through PostgreSQL’s archive_command for a server. If set to true (default), Barman expects that continuous archiving for a server is in place and will activate checks as well as management (including compression) of WAL files that Postgres deposits in the incoming directory. Setting it to false, will disable standard continuous archiving for a server. Global/Server. (NOTE: this option is currently required to be enabled until Barman natively supports physical replication slots. Setting it to false will result in a disabled server).
This option allows you to activate batch processing of WAL files for the archiver process, by setting it to a value > 0. Otherwise, the traditional unlimited processing of the WAL queue is enabled. When batch processing is activated, the archive-wal process would limit itself to maximum archiver_batch_size WAL segments per single run. Integer. Global/Server.
Directory where backup data for a server will be placed. Server.
Configure the method barman used for backup execution. If set to rsync (default), barman will execute backup using the rsync command. If set to postgres barman will use the pg_basebackup command to execute the backup. Global/Server.
This option allows you to control the way Barman interacts with PostgreSQL for backups. If set to exclusive_backup (default), barman backup executes backup operations using the standard exclusive backup approach (technically through pg_start_backup/pg_stop_backup). If set to concurrent_backup, if using PostgreSQL 9.2, 9.3, 9.4, and 9.5, Barman requires the pgespresso module to be installed on the PostgreSQL server and can be used to perform a backup from a standby server. Starting from PostgreSQL 9.6, Barman uses the new PostgreSQL API to perform backups from a standby server. Global/Server.
This option allows you to specify a maximum transfer rate in kilobytes per second. A value of zero specifies no limit (default). Global/Server.
Main data directory for Barman. Global.
Directory for locks. Default: %(barman_home)s. Global.
Directory where base backups will be placed. Server.
Number of seconds of wait after a failed copy, before retrying Used during both backup and recovery operations. Positive integer, default 30. Global/Server.
Number of retries of base backup copy, after an error. Used during both backup and recovery operations. Positive integer, default 0. Global/Server.
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.
Standard compression algorithm applied to WAL files. Possible values are: gzip (requires gzip to be installed on the system), bzip2 (requires bzip2), pigz (requires pigz), pygzip (Python’s internal gzip compressor) and pybzip2 (Python’s internal bzip2 compressor). Global/Server.
Connection string used by Barman to connect to the Postgres server. This is a libpq connection string, consult the PostgreSQL manual for more information. Commonly used keys are: host, hostaddr, port, dbname, user, password. Server.
Customised compression algorithm applied to WAL files. Global/Server.
Customised decompression algorithm applied to compressed WAL files; this must match the compression algorithm. Global/Server.
A human readable description of a server. Server.
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).
This option allows you to control the way PostgreSQL handles checkpoint at the start of the backup. If set to false (default), the I/O workload for the checkpoint will be limited, according to the checkpoint_completion_target setting on the PostgreSQL server. If set to true, an immediate checkpoint will be requested, meaning that PostgreSQL will complete the checkpoint as soon as possible. Global/Server.
Directory where incoming WAL files are archived into. Requires archiver to be enabled. Server.
This option identifies a time frame that must contain the latest backup. If the latest backup is older than the time frame, barman check command will report an error to the user. If empty (default), latest backup is always considered valid. Syntax for this option is: “i (DAYS | WEEKS | MONTHS)” where i is a integer greater than zero, representing the number of days | weeks | months of the time frame. Global/Server.
Location of Barman’s log file. Global.
Level of logging (DEBUG, INFO, WARNING, ERROR, CRITICAL). Global.
Minimum number of backups to be retained. Default 0. Global/Server.
This option allows you to enable data compression for network transfers. If set to false (default), no compression is used. If set to true, compression is enabled, reducing network usage. Global/Server.
One or more absolute paths, separated by colon, where Barman looks for executable files. The paths specified in path_prefix are tried before the ones specified in PATH environment variable. Global/server.
Hook script launched after a WAL file is archived by maintenance. Being this a retry hook script, Barman will retry the execution 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.
Hook script launched after a WAL file is archived by maintenance, after ‘post_archive_retry_script’. Global/Server.
Hook script launched after a base backup. Being this a retry hook script, Barman will retry the execution 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.
Hook script launched after a base backup, after ‘post_backup_retry_script’. Global/Server.
Hook script launched before a WAL file is archived by maintenance, after ‘pre_archive_script’. Being this a retry hook script, Barman will retry the execution 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.
Hook script launched before a WAL file is archived by maintenance. Global/Server.
Hook script launched before a base backup, after ‘pre_backup_script’. Being this a retry hook script, Barman will retry the execution 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.
Hook script launched before a base backup. Global/Server.
Options for recovery operations. Currently only supports get-wal. get-wal activates generation of a basic restore_command in the resulting recovery.conf file that uses the barman get-wal command to fetch WAL files directly from Barman’s archive of WALs. Comma separated list of values, default empty. Global/Server.
Policy for retention of periodic backups and archive logs. If left empty, retention policies are not enforced. For redundancy based retention policy use “REDUNDANCY i” (where i is an integer > 0 and defines the number of backups to retain). For recovery window retention policy use “RECOVERY WINDOW OF i DAYS” or “RECOVERY WINDOW OF i WEEKS” or “RECOVERY WINDOW OF i MONTHS” where i is 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.
Currently only “auto” is implemented. Global/Server.
This option controls incremental backup support. Global/Server. Possible values are: * off: disabled (default); * copy: reuse the last available backup for a server and create a copy of the unchanged files (reduce backup time); * link: 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.
Physical replication slot to be used by the receive-wal command when streaming_archiver is set to on. Requires PostgreSQL >= 9.4. Global/Server. Default: None (disabled).
This option allows you to use the PostgreSQL’s streaming protocol to receive transaction logs from a server. If set to on, Barman expects to find pg_receivexlog in the PATH (see path_prefix option) and that streaming connection for the server is working. This activates connection checks as well as management (including compression) of WAL files. If set to off (default) barman will rely only on continuous archiving for a server WAL archive operations, eventually terminating any running pg_receivexlog for the server. Global/Server.
This option allows you to activate batch processing of WAL files for the streaming_archiver process, by setting it to a value > 0. Otherwise, the traditional unlimited processing of the WAL queue is enabled. When batch processing is activated, the archive-wal process would limit itself to maximum streaming_archiver_batch_size WAL segments per single run. Integer. Global/Server.
Identifier to be used as application_name by the receive-wal command. Only available with pg_receivexlog >= 9.3. By default it is set to barman_receive_wal. Global/Server.
Identifier to be used as application_name by the pg_basebackup command. Only available with pg_basebackup >= 9.3. By default it is set to barman_streaming_backup. Global/Server.
Connection string used by Barman to connect to the Postgres server via streaming replication protocol. By default it is set to conninfo. Server.
Directory where WAL files are streamed from the PostgreSQL server to Barman. Requires streaming_archiver to be enabled. Server.
Command used by Barman to login to the Postgres server via ssh. Server.
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.
Policy for retention of archive logs (WAL files). Currently only “MAIN” is available. Global/Server.
Directory which contains WAL files. Server.
The script definition is passed to a shell and can return any exit code.
The shell environment will contain the following variables:
configuration file used by barman
error message, if any (only for the ‘post’ phase)
‘pre’ or ‘post’
1 if it is a retry script (from 1.5.0), 0 if not
name of the server
Backup scripts specific variables:
backup destination directory
ID of the backup
ID of the previous backup (if present)
status of the backup
version of Barman
Archive scripts specific variables:
name of the WAL file
full path of the WAL file
size of the WAL file
WAL file timestamp
type of compression used for the WAL file
Only in case of retry hook scripts, the exit code of the script is checked by Barman. Output of hook scripts is simply written in the log file.