1BARMAN-CLOUD-WAL-ARCHIVE(1)      Version 2.10      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

REFERENCES

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

DEPENDENCIES

69       · boto3
70

EXIT STATUS

72       0      Success
73
74       Not zero
75              Failure
76

SEE ALSO

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

BUGS

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

RESOURCES

91       · Homepage: <http://www.pgbarman.org/>
92
93       · Documentation: <http://docs.pgbarman.org/>
94
95       · Professional support: <http://www.2ndQuadrant.com/>
96

COPYING

98       Barman  is the property of 2ndQuadrant Limited and its code is distrib‐
99       uted under GNU General Public License v3.
100
101       Copyright  (C)  2011-2019  2ndQuadrant   Ltd   -   <http://www.2ndQuad‐
102       rant.com/>.
103

AUTHORS

105       2ndQuadrant <http://www.2ndQuadrant.com>.
106
107
108
109Barman User manuals            December 5, 2019    BARMAN-CLOUD-WAL-ARCHIVE(1)
Impressum