barman-cloud-backup-keep - Man Page
Flag backups which should be kept forever
Synopsis
barman-cloud-backup-keep [Options] SOURCE_URL SERVER_NAME BACKUP_ID
Description
This script can be used to flag backups previously made with barman-cloud-backup
as archival backups. Archival backups are kept forever regardless of any retention policies applied.
This script and Barman are administration tools for disaster recovery of PostgreSQL servers written in Python and maintained by EnterpriseDB.
Positional Arguments
- SOURCE_URL
URL of the cloud source, such as a bucket in AWS S3. For example:
s3://BUCKET_NAME/path/to/folder
(whereBUCKET_NAME
is the bucket you have created in AWS).- SERVER_NAME
the name of the server as configured in Barman.
- BACKUP_ID
a valid Backup ID for a backup in cloud storage
Options
- -h, –help
show a help message and exit
- -V, –version
show program's version number and exit
- -v, –verbose
increase output verbosity (e.g., -vv is more than -v)
- -q, –quiet
decrease output verbosity (e.g., -qq is less than -q)
- -t, –test
test connectivity to the cloud destination and exit
- –target RECOVERY_TARGET
Specify the recovery target for the archival backup. Possible values for RECOVERY_TARGET are:
- full: The backup can always be used to recover to the latest point in time. To achieve this, Barman will retain all WALs needed to ensure consistency of the backup and all subsequent WALs.
- standalone: The backup can only be used to recover the server to its state at the time the backup was taken. Barman will only retain the WALs needed to ensure consistency of the backup.
- -s, –status
Report the archival status of the backup. This will either be the recovery target of full or standalone for archival backups or nokeep for backups which have not been flagged as archival.
- -r, –release
Release the keep flag from this backup. This will remove its archival status and make it available for deletion, either directly or by retention policy.
- –cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
the cloud provider to which the backup should be uploaded
- -P, –profile
profile name (e.g. INI section in AWS credentials file)
- –endpoint-url
override the default S3 URL construction mechanism by specifying an endpoint.
- –credential {azure-cli,managed-identity}
optionally specify the type of credential to use when authenticating with Azure Blob Storage. If omitted then the credential will be obtained from the environment. If no credentials can be found in the environment then the default Azure authentication flow will be used.
References
For Boto:
For AWS:
- https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html
- https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html.
For Azure Blob Storage:
- https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-data-operations-cli#set-environment-variables-for-authorization-parameters
- https://docs.microsoft.com/en-us/python/api/azure-storage-blob/?view=azure-python
For Google Cloud Storage: * Credentials: https://cloud.google.com/docs/authentication/getting-started#setting_the_environment_variable
Only authentication with GOOGLE_APPLICATION_CREDENTIALS
env is supported at the moment.
Dependencies
If using --cloud-provider=aws-s3
:
- boto3
If using --cloud-provider=azure-blob-storage
:
- azure-storage-blob
- azure-identity (optional, if you wish to use DefaultAzureCredential)
If using --cloud-provider=google-cloud-storage
* google-cloud-storage
Exit Status
- 0
Success
- 1
The keep command was not successful
- 2
The connection to the cloud provider failed
- 3
There was an error in the command input
- Other non-zero codes
Failure
Bugs
Barman has been extensively tested, and is currently being used in several production environments. However, we cannot exclude the presence of bugs.
Any bug can be reported via the Github issue tracker.
Resources
- Homepage: <https://www.pgbarman.org/>
- Documentation: <https://docs.pgbarman.org/>
- Professional support: <https://www.enterprisedb.com/>
Copying
Barman is the property of EnterpriseDB UK Limited and its code is distributed under GNU General Public License v3.
© Copyright EnterpriseDB UK Limited 2011-2022
Authors
EnterpriseDB <https://www.enterprisedb.com>.