/usr/share/barman/bin/barman-cloud-wal-archive

usage: barman-cloud-wal-archive [-V] [--help] [-v | -q] [-t]
                                [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}]
                                [--endpoint-url ENDPOINT_URL] [-P AWS_PROFILE]
                                [--profile AWS_PROFILE] [--read-timeout READ_TIMEOUT]
                                [--addressing-style {auto,virtual,path}]
                                [--azure-credential {azure-cli,managed-identity,default}]
                                [-z | -j | --xz | --snappy | --zstd | --lz4]
                                [--compression-level COMPRESSION_LEVEL] [--tags [TAGS_LIST ...] |
                                --tag TAGS_APPEND] [--history-tags [HISTORY_TAGS_LIST ...] |
                                --history-tag HISTORY_TAGS_APPEND] [--kms-key-name KMS_KEY_NAME]
                                [-e ENCRYPTION] [--sse-kms-key-id SSE_KMS_KEY_ID]
                                [--sse-customer-key SSE_CUSTOMER_KEY]
                                [--encryption-scope ENCRYPTION_SCOPE]
                                [--max-block-size MAX_BLOCK_SIZE]
                                [--max-concurrency MAX_CONCURRENCY]
                                [--max-single-put-size MAX_SINGLE_PUT_SIZE]
                                destination_url server_name [wal_path]

This script can be used in the `archive_command` of a PostgreSQL server to ship WAL files to the
Cloud. Currently AWS S3, Azure Blob Storage and Google Cloud Storage are supported.

positional arguments:
  destination_url       URL of the cloud destination, such as a bucket in AWS S3. For example:
                        `s3://bucket/path/to/folder`.
  server_name           the name of the server as configured in Barman.
  wal_path              the value of the '%p' keyword (according to 'archive_command').

options:
  -V, --version         show program's version number and exit
  --help                show this help message 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 cloud connectivity and exit
  --cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
                        The cloud provider to use as a storage backend
  -z, --gzip            gzip-compress the WAL while uploading to the cloud
  -j, --bzip2           bzip2-compress the WAL while uploading to the cloud
  --xz                  xz-compress the WAL while uploading to the cloud
  --snappy              snappy-compress the WAL while uploading to the cloud (requires optional
                        python-snappy library)
  --zstd                zstd-compress the WAL while uploading to the cloud (requires optional
                        zstandard library)
  --lz4                 lz4-compress the WAL while uploading to the cloud (requires optional lz4
                        library)
  --compression-level COMPRESSION_LEVEL
                        A compression level for the specified compression algorithm
  --tags [TAGS_LIST ...]
                        Tags to be added to all uploaded files in cloud storage
  --tag TAGS_APPEND     Tags to be added to archived WAL files in cloud storage
  --history-tags [HISTORY_TAGS_LIST ...]
                        Tags to be added to archived history files in cloud storage
  --history-tag HISTORY_TAGS_APPEND
                        Tags to be added to archived history files in cloud storage

Extra options for the aws-s3 cloud provider:
  --endpoint-url ENDPOINT_URL
                        Override default S3 endpoint URL with the given one
  -P AWS_PROFILE, --aws-profile AWS_PROFILE
                        profile name (e.g. INI section in AWS credentials file)
  --profile AWS_PROFILE
                        profile name (deprecated: replaced by --aws-profile)
  --read-timeout READ_TIMEOUT
                        the time in seconds until a timeout is raised when waiting to read from a
                        connection (defaults to 60 seconds)
  --addressing-style {auto,virtual,path}
                        the addressing style to use for S3 requests. Valid values are 'auto'
                        (default), 'virtual' (virtual-hosted-style), or 'path' (path-style)
  -e ENCRYPTION, --encryption ENCRYPTION
                        The encryption algorithm used when storing the uploaded data in S3.
                        Allowed values: 'AES256'|'aws:kms'.
  --sse-kms-key-id SSE_KMS_KEY_ID
                        The AWS KMS key ID that should be used for encrypting the uploaded data in
                        S3. Can be specified using the key ID on its own or using the full ARN for
                        the key. Only allowed if `-e/--encryption` is set to `aws:kms`.
  --sse-customer-key SSE_CUSTOMER_KEY
                        Path to a file containing the customer-provided encryption key (SSE-C) to
                        use for encrypting and decrypting data in S3, specified as a file:// URI
                        (e.g. file:///path/to/key.b64). The file must contain a base64-encoded
                        256-bit key. Cannot be used together with --encryption or --sse-kms-key-
                        id.

Extra options for the azure-blob-storage cloud provider:
  --azure-credential {azure-cli,managed-identity,default}, --credential {azure-cli,managed-identity,default}, --default {azure-cli,managed-identity,default}
                        Optionally specify the type of credential to use when authenticating with
                        Azure. If omitted then Azure Blob Storage credentials will be obtained
                        from the environment and the default Azure authentication flow will be
                        used for authenticating with all other Azure services. If no credentials
                        can be found in the environment then the default Azure authentication flow
                        will also be used for Azure Blob Storage.
  --encryption-scope ENCRYPTION_SCOPE
                        The name of an encryption scope defined in the Azure Blob Storage service
                        which is to be used to encrypt the data in Azure
  --max-block-size MAX_BLOCK_SIZE
                        The chunk size to be used when uploading an object via the concurrent
                        chunk method (default: 4MB).
  --max-concurrency MAX_CONCURRENCY
                        The maximum number of chunks to be uploaded concurrently (default: 1).
  --max-single-put-size MAX_SINGLE_PUT_SIZE
                        Maximum size for which the Azure client will upload an object in a single
                        request (default: 64MB). If this is set lower than the PostgreSQL WAL
                        segment size after any applied compression then the concurrent chunk
                        upload method for WAL archiving will be used.

Extra options for google-cloud-storage cloud provider:
  --kms-key-name KMS_KEY_NAME
                        The name of the GCP KMS key which should be used for encrypting the
                        uploaded data in GCS.