1BARMAN-CLOUD-WAL-ARCHIVE(1)      Version 2.12      BARMAN-CLOUD-WAL-ARCHIVE(1)
2
3
4

NAME

6       barman-cloud-wal-archive  -  Archive  PostgreSQL WAL files in the Cloud
7       using archive_command
8

SYNOPSIS

10       barman-cloud-wal-archive [OPTIONS] DESTINATION_URL SERVER_NAME WAL_PATH
11

DESCRIPTION

13       This script can be used in the archive_command of a  PostgreSQL  server
14       to ship WAL files to the Cloud.  Currently only AWS S3 is supported.
15
16       This  script  and Barman are administration tools for disaster recovery
17       of PostgreSQL servers written in Python and maintained by 2ndQuadrant.
18

POSITIONAL ARGUMENTS

20       DESTINATION_URL
21              URL of the cloud destination, such as a bucket in AWS  S3.   For
22              example:  s3://BUCKET_NAME/path/to/folder  (where BUCKET_NAME is
23              the bucket you have created in AWS).
24
25       SERVER_NAME
26              the name of the server as configured in Barman.
27
28       WAL_PATH
29              the value of the `%p' keyword (according to `archive_command').
30

OPTIONS

32       -h, –help
33              show a help message and exit
34
35       -V, –version
36              show program’s version number and exit
37
38       -t, –test
39              test connectivity to the cloud destination and exit
40
41       -P, –profile
42              profile name (e.g. INI section in AWS credentials file)
43
44       -z, –gzip
45              gzip-compress the WAL while uploading to the cloud
46
47       -j, –bzip2
48              bzip2-compress the WAL while uploading to the cloud
49
50       -e ENCRYPT, –encrypt ENCRYPT
51              enable server-side encryption with  the  given  method  for  the
52              transfer.  Allowed methods: AES256 and aws:kms.
53
54       –endpoint-url
55              override the default S3 URL construction mechanism by specifying
56              an endpoint.
57

REFERENCES

59       For Boto:
60
61       · https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
62         uration.html
63
64       For AWS:
65
66       · http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-
67         up.html
68
69       · http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-
70         started.html.
71

DEPENDENCIES

73       · boto3
74

EXIT STATUS

76       0      Success
77
78       Not zero
79              Failure
80

SEE ALSO

82       This script can be used in conjunction with pre_archive_retry_script to
83       relay WAL files to S3, as follows:
84
85              pre_archive_retry_script = 'barman-cloud-wal-archive [*OPTIONS*] *DESTINATION_URL* ${BARMAN_SERVER} ${BARMAN_FILE}'
86

BUGS

88       Barman has been extensively tested, and is currently being used in sev‐
89       eral  production environments.  However, we cannot exclude the presence
90       of bugs.
91
92       Any bug can be reported via the Github issue tracker.
93

RESOURCES

95       · Homepage: <http://www.pgbarman.org/>
96
97       · Documentation: <http://docs.pgbarman.org/>
98
99       · Professional support: <http://www.2ndQuadrant.com/>
100

COPYING

102       Barman is the property of 2ndQuadrant Limited and its code is  distrib‐
103       uted under GNU General Public License v3.
104
105       Copyright   (C)   2011-2020   2ndQuadrant  Ltd  -  <http://www.2ndQuad‐
106       rant.com/>.
107

AUTHORS

109       2ndQuadrant <http://www.2ndQuadrant.com>.
110
111
112
113Barman User manuals            November 5, 2020    BARMAN-CLOUD-WAL-ARCHIVE(1)
Impressum