1BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1) Version BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1)
23.9.0"
6
8 barman-cloud-check-wal-archive - Check a WAL archive destination for a
9 new PostgreSQL cluster
10
12 barman-cloud-check-wal-archive [OPTIONS] SOURCE_URL SERVER_NAME
13
15 Check that the WAL archive destination for SERVER_NAME is safe to use
16 for a new PostgreSQL cluster. With no optional args (the default) this
17 check will pass if the WAL archive is empty or if the target bucket
18 cannot be found. All other conditions will result in failure.
19 This script and Barman are administration tools for disaster recovery
21 of PostgreSQL servers written in Python and maintained by EnterpriseDB.
22
24 usage: barman-cloud-check-wal-archive [-V] [--help] [-v | -q] [-t]
25 [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}]
26 [--endpoint-url ENDPOINT_URL]
27 [-P AWS_PROFILE] [--profile AWS_PROFILE]
28 [--read-timeout READ_TIMEOUT]
29 [--azure-credential {azure-cli,managed-identity}]
30 [--timeline TIMELINE]
31 destination_url server_name
32 Checks that the WAL archive on the specified cloud storage can be safely used
34 for a new PostgreSQL server.
35 positional arguments:
37 destination_url URL of the cloud destination, such as a bucket in AWS
38 S3. For example: `s3://bucket/path/to/folder`.
39 server_name the name of the server as configured in Barman.
40 optional arguments:
42 -V, --version show program's version number and exit
43 --help show this help message and exit
44 -v, --verbose increase output verbosity (e.g., -vv is more than -v)
45 -q, --quiet decrease output verbosity (e.g., -qq is less than -q)
46 -t, --test Test cloud connectivity and exit
47 --cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
48 The cloud provider to use as a storage backend
49 --timeline TIMELINE The earliest timeline whose WALs should cause the
50 check to fail
51 Extra options for the aws-s3 cloud provider:
53 --endpoint-url ENDPOINT_URL
54 Override default S3 endpoint URL with the given one
55 -P AWS_PROFILE, --aws-profile AWS_PROFILE
56 profile name (e.g. INI section in AWS credentials
57 file)
58 --profile AWS_PROFILE
59 profile name (deprecated: replaced by --aws-profile)
60 --read-timeout READ_TIMEOUT
61 the time in seconds until a timeout is raised when
62 waiting to read from a connection (defaults to 60
63 seconds)
64 Extra options for the azure-blob-storage cloud provider:
66 --azure-credential {azure-cli,managed-identity}, --credential {azure-cli,managed-identity}
67 Optionally specify the type of credential to use when
68 authenticating with Azure. If omitted then Azure Blob
69 Storage credentials will be obtained from the
70 environment and the default Azure authentication flow
71 will be used for authenticating with all other Azure
72 services. If no credentials can be found in the
73 environment then the default Azure authentication flow
74 will also be used for Azure Blob Storage.
75
77 For Boto:
78 • https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
80 uration.html
81 For AWS:
83 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
85 ting-set-up.html
86 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
88 ting-started.html.
89 For Azure Blob Storage:
91 • https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-da‐
93 ta-operations-cli#set-environment-variables-for-authorization-parame‐
94 ters
95 • https://docs.microsoft.com/en-us/python/api/azure-stor‐
97 age-blob/?view=azure-python
98 For Google Cloud Storage: * Credentials:
100 https://cloud.google.com/docs/authentication/getting-started#set‐
101 ting_the_environment_variable
102 Only authentication with GOOGLE_APPLICATION_CREDENTIALS env is support‐
104 ed at the moment.
105
107 If using --cloud-provider=aws-s3:
108 • boto3
110 If using --cloud-provider=azure-blob-storage:
112 • azure-storage-blob
114 • azure-identity (optional, if you wish to use DefaultAzureCredential)
116 If using --cloud-provider=google-cloud-storage * google-cloud-storage
118
120 0 Success
121 1 Failure
123 2 The connection to the cloud provider failed
125 3 There was an error in the command input
127 Other non-zero codes
129 Error running the check
130
132 Barman has been extensively tested, and is currently being used in sev‐
133 eral production environments. However, we cannot exclude the presence
134 of bugs.
135 Any bug can be reported via the GitHub issue tracker.
137
139 • Homepage: <https://www.pgbarman.org/>
140 • Documentation: <https://docs.pgbarman.org/>
142 • Professional support: <https://www.enterprisedb.com/>
144
146 Barman is the property of EnterpriseDB UK Limited and its code is dis‐
147 tributed under GNU General Public License v3.
148 © Copyright EnterpriseDB UK Limited 2011-2023
150
152 EnterpriseDB <https://www.enterprisedb.com>.
153Barman User manuals October 3, 202B3ARMAN-CLOUD-CHECK-WAL-ARCHIVE(1)