1BARMAN-CLOUD-BACKUP(1)           Version 2.12           BARMAN-CLOUD-BACKUP(1)
2
3
4

NAME

6       barman-cloud-backup - Backup a PostgreSQL instance and stores it in the
7       Cloud
8

SYNOPSIS

10       barman-cloud-backup [OPTIONS] DESTINATION_URL SERVER_NAME
11

DESCRIPTION

13       This script can be used to perform a backup of a local  PostgreSQL  in‐
14       stance  and  ship  the  resulting tarball(s) to the Cloud.  It requires
15       read access to PGDATA and tablespaces (normally run as postgres  user).
16       Currently only AWS S3 is supported.
17
18       This  script  and Barman are administration tools for disaster recovery
19       of PostgreSQL servers written in Python and maintained by 2ndQuadrant.
20
21       IMPORTANT: the Cloud upload process may fail if any file  with  a  size
22       greater than the configured --max-archive-size is present either in the
23       data directory or in  any  tablespaces.   However,  PostgreSQL  creates
24       files  with a maximum size of 1GB, and that size is always allowed, re‐
25       gardless of the max-archive-size parameter.
26

POSITIONAL ARGUMENTS

28       DESTINATION_URL
29              URL of the cloud destination, such as a bucket in AWS  S3.   For
30              example:  s3://BUCKET_NAME/path/to/folder  (where BUCKET_NAME is
31              the bucket you have created in AWS).
32
33       SERVER_NAME
34              the name of the server as configured in Barman.
35

OPTIONS

37       -h, –help
38              show a help message and exit
39
40       -V, –version
41              show program’s version number and exit
42
43       -v, –verbose
44              increase output verbosity (e.g., -vv is more than -v)
45
46       -q, –quiet
47              decrease output verbosity (e.g., -qq is less than -q)
48
49       -t, –test
50              test connectivity to the cloud destination and exit
51
52       -P, –profile
53              profile name (e.g. INI section in AWS credentials file)
54
55       -z, –gzip
56              gzip-compress the tar files when uploading to the cloud
57
58       -j, –bzip2
59              bzip2-compress the tar files when uploading to the cloud
60
61       -e, –encrypt
62              enable server-side encryption for the transfer.  Allowed values:
63              `AES256'|`aws:kms'.
64
65       -h, –host
66              host  or  Unix  socket for PostgreSQL connection (default: libpq
67              settings)
68
69       -p, –port
70              port for PostgreSQL connection (default: libpq settings)
71
72       -U, –user
73              user name for PostgreSQL connection (default: libpq settings)
74
75       –immediate-checkpoint
76              forces the initial checkpoint to be done as quickly as possible
77
78       -J JOBS, –jobs JOBS
79              number of subprocesses to upload data to S3 (default: 2)
80
81       -S MAX_ARCHIVE_SIZE, –max-archive-size MAX_ARCHIVE_SIZE
82              maximum size of an archive when uploading to S3 (default: 100GB)
83
84       –endpoint-url
85              override the default S3 URL construction mechanism by specifying
86              an endpoint.
87

REFERENCES

89       For Boto:
90
91       · https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
92         uration.html
93
94       For AWS:
95
96       · http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-
97         up.html
98
99       · http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-
100         started.html.
101
102       For libpq settings information:
103
104       · https://www.postgresql.org/docs/current/libpq-envars.html
105

DEPENDENCIES

107       · boto3
108

EXIT STATUS

110       0      Success
111
112       Not zero
113              Failure
114

BUGS

116       Barman has been extensively tested, and is currently being used in sev‐
117       eral  production environments.  However, we cannot exclude the presence
118       of bugs.
119
120       Any bug can be reported via the Github issue tracker.
121

RESOURCES

123       · Homepage: <http://www.pgbarman.org/>
124
125       · Documentation: <http://docs.pgbarman.org/>
126
127       · Professional support: <http://www.2ndQuadrant.com/>
128

COPYING

130       Barman is the property of 2ndQuadrant Limited and its code is  distrib‐
131       uted under GNU General Public License v3.
132
133       Copyright   (C)   2011-2020   2ndQuadrant  Ltd  -  <http://www.2ndQuad‐
134       rant.com/>.
135

AUTHORS

137       2ndQuadrant <http://www.2ndQuadrant.com>.
138
139
140
141Barman User manuals            November 5, 2020         BARMAN-CLOUD-BACKUP(1)