1BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1)   Version  BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1)
2
3
4
53.0.1"
6

NAME

8       barman-cloud-check-wal-archive  - Check a WAL archive destination for a
9       new PostgreSQL cluster
10

SYNOPSIS

12       barman-cloud-check-wal-archive [OPTIONS] SOURCE_URL SERVER_NAME
13

DESCRIPTION

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
20       This  script  and Barman are administration tools for disaster recovery
21       of PostgreSQL servers written in Python and maintained by EnterpriseDB.
22

POSITIONAL ARGUMENTS

24       SOURCE_URL
25              URL of the cloud source, such as a bucket in AWS S3.  For  exam‐
26              ple:  s3://BUCKET_NAME/path/to/folder  (where BUCKET_NAME is the
27              bucket you have created in AWS).
28
29       SERVER_NAME
30              the name of the server as configured in Barman.
31

OPTIONS

33       -h, –help
34              show a help message and exit
35
36       -V, –version
37              show program's version number and exit
38
39       -v, –verbose
40              increase output verbosity (e.g., -vv is more than -v)
41
42       -q, –quiet
43              decrease output verbosity (e.g., -qq is less than -q)
44
45       -t, –test
46              test connectivity to the cloud destination and exit
47
48       –timeline
49              A positive integer specifying the earliest  timeline  for  which
50              associated  WALs should cause the check to fail.  The check will
51              pass if all WAL content in the archive relates to earlier  time‐
52              lines.   If  any  WAL files are on this timeline or greater then
53              the check will fail.
54
55       –cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
56              the cloud provider to which the backup should be uploaded
57
58       -P, –profile
59              profile name (e.g. INI section in AWS credentials file)
60
61       –endpoint-url
62              override the default S3 URL construction mechanism by specifying
63              an endpoint.
64
65       –credential {azure-cli,managed-identity}
66              optionally  specify the type of credential to use when authenti‐
67              cating with Azure Blob Storage.  If omitted then the  credential
68              will be obtained from the environment.  If no credentials can be
69              found in the environment then the default  Azure  authentication
70              flow will be used.
71

REFERENCES

73       For Boto:
74
75       • https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
76         uration.html
77
78       For AWS:
79
80       • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
81         ting-set-up.html
82
83       • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
84         ting-started.html.
85
86       For Azure Blob Storage:
87
88       • https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-da‐
89         ta-operations-cli#set-environment-variables-for-authorization-parame‐
90         ters
91
92       • https://docs.microsoft.com/en-us/python/api/azure-stor‐
93         age-blob/?view=azure-python
94
95       For        Google       Cloud       Storage:       *       Credentials:
96       https://cloud.google.com/docs/authentication/getting-started#set‐
97       ting_the_environment_variable
98
99       Only authentication with GOOGLE_APPLICATION_CREDENTIALS env is support‐
100       ed at the moment.
101

DEPENDENCIES

103       If using --cloud-provider=aws-s3:
104
105       • boto3
106
107       If using --cloud-provider=azure-blob-storage:
108
109       • azure-storage-blob
110
111       • azure-identity (optional, if you wish to use DefaultAzureCredential)
112
113       If using --cloud-provider=google-cloud-storage * google-cloud-storage
114

EXIT STATUS

116       0      Success
117
118       1      Failure
119
120       2      The connection to the cloud provider failed
121
122       3      There was an error in the command input
123
124       Other non-zero codes
125              Error running the check
126

BUGS

128       Barman has been extensively tested, and is currently being used in sev‐
129       eral  production environments.  However, we cannot exclude the presence
130       of bugs.
131
132       Any bug can be reported via the Github issue tracker.
133

RESOURCES

135       • Homepage: <https://www.pgbarman.org/>
136
137       • Documentation: <https://docs.pgbarman.org/>
138
139       • Professional support: <https://www.enterprisedb.com/>
140

COPYING

142       Barman is the property of EnterpriseDB UK Limited and its code is  dis‐
143       tributed under GNU General Public License v3.
144
145       © Copyright EnterpriseDB UK Limited 2011-2022
146

AUTHORS

148       EnterpriseDB <https://www.enterprisedb.com>.
149
150
151
152Barman User manuals              June 27, 2022BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1)