Barman client utilities ( barman-cli )¶
Formerly a separate open-source project, barman-cli has been merged
into Barman’s core since version 2.8, and is distributed as an
RPM/Debian package. barman-cli contains a set of recommended client
utilities to be installed alongside the PostgreSQL server:
For more detailed information, please refer to the specific man pages or
the --help option.
Installation¶
Barman client utilities are normally installed where PostgreSQL is
installed. Our recommendation is to install the barman-cli package
on every PostgreSQL server, being that primary or standby.
Please refer to the main “Installation” section to install the repositories.
To install the package on RedHat/CentOS system, as root type:
yum install barman-cli
On Debian/Ubuntu, as root user type:
apt-get install barman-cli
Barman client utilities for the Cloud ( barman-cli-cloud )¶
Barman client utilities have been extended to support object storage integration and enhance disaster recovery capabilities of your PostgreSQL databases by relaying WAL files and backups to a supported cloud provider.
Supported cloud providers are:
AWS S3 (or any S3 compatible object store)
Azure Blob Storage
Google Cloud Storage (Rest API)
These utilities are distributed in the barman-cli-cloud RPM/Debian
package, and can be installed alongside the PostgreSQL server:
For information on how to setup credentials for the aws-s3 cloud provider please refer to the Credentials .
- For credentials for the azure-blob-storage cloud provider see the
Environment variables for authorization parameters . The following environment variables are supported:
AZURE_STORAGE_CONNECTION_STRING , AZURE_STORAGE_KEY and
AZURE_STORAGE_SAS_TOKEN . You can also use the --credential
option to specify either azure-cli or managed-identity
credentials in order to authenticate via Azure Active Directory.
Warning
Cloud utilities require the appropriate library for the cloud provider you wish to use - either: (https://github.com/boto/boto3) [boto3] or (https://docs.microsoft.com/en-us/python/api/azure-storage-blob/?view=azure-python) [azure-storage-blob] and (optionally) (https://docs.microsoft.com/en-us/python/api/azure-identity/?view=azure-python) [azure-identity]
Installation¶
Barman client utilities for the Cloud need to be installed on those PostgreSQL servers that you want to direcly backup to a cloud provider, bypassing Barman.
In case you want to use barman-cloud-backup and/or
barman-cloud-wal-archive as hook scripts, you can install the
barman-cli-cloud package on the Barman server also.
Please refer to the main “Installation” section to install the repositories.
To install the package on RedHat/CentOS system, as root type:
yum install barman-cli-cloud
On Debian/Ubuntu, as root user type:
apt-get install barman-cli-cloud
barman-cloud hook scripts¶
Install the barman-cli-cloud package on the Barman server as
described above.
Configure barman-cloud-backup as a post backup script by adding the
following to the Barman configuration for a PostgreSQL server:
post_backup_retry_script = barman-cloud-backup [*OPTIONS*] *DESTINATION_URL* ${BARMAN_SERVER}
Warning
When running as a hook script barman-cloud-backup requires that the status of the backup is DONE and it will fail if the backup has any other status. For this reason it is recommended backups are run with the -w / –wait option so that the hook script is not executed while a backup has status WAITING_FOR_WALS .
Configure barman-cloud-wal-archive as a pre WAL archive script by
adding the following to the Barman configuration for a PostgreSQL
server:
pre_archive_retry_script = barman-cloud-wal-archive [*OPTIONS*] *DESTINATION_URL* ${BARMAN_SERVER}
Selecting a cloud provider¶
Use the --cloud-provider option to choose the cloud provider for
your backups and WALs. This can be set to one of the following:
aws-s3 [DEFAULT]: AWS S3 or S3-compatible object store.
azure-blob-storage : Azure Blob Storage service.
google-cloud-storage : Google Cloud Storage service.
Specificity by provider¶
Google Cloud Storage¶
set up¶
It will need google_storage_client dependency:
bash pip3 install google-cloud-storage
To set credentials:
Set bucket access rights:
We suggest to give Storage Admin Role to the service account on the bucket.
When using barman_cloud, If the bucket does not exist, it will be created. Default options will be used to create the bucket. If you need the bucket to have specific options (region, storage class, labels), it is advised to create and set the bucket to match all you needs.
If running barman cloud from postgres (archive_command or
restore_command), do not forget to set
GOOGLE_APPLICATION_CREDENTIALS in postgres environment file.
