mirror of
https://github.com/EnterpriseDB/repmgr.git
synced 2026-03-25 08:06:29 +00:00
Barman support, draft #1
TODO: we need to check what happens with configuration files placed in non-standard locations.
This commit is contained in:
70
README.md
70
README.md
@@ -504,6 +504,76 @@ standby's upstream server is the replication cluster master. While of limited
|
||||
use in a simple master/standby replication cluster, this information is required
|
||||
to effectively manage cascading replication (see below).
|
||||
|
||||
### Using Barman to clone a standby
|
||||
|
||||
`repmgr standby clone` also supports Barman, the Backup and
|
||||
Replication manager (http://www.pgbarman.org/), as a provider of both
|
||||
base backups and WAL files.
|
||||
|
||||
Barman support provides the following advantages:
|
||||
|
||||
- the primary node does not need to perform a new backup every time a
|
||||
new standby is cloned;
|
||||
- a standby node can be disconnected for longer periods without losing
|
||||
the ability to catch up, and without causing accumulation of WAL
|
||||
files on the primary node;
|
||||
- therefore, `repmgr` does not need to use replication slots, and the
|
||||
primary node does not need to set `wal_keep_segments`.
|
||||
|
||||
> *NOTE*: In view of the above, Barman support is incompatible with
|
||||
> the `use_replication_slots` setting in `repmgr.conf`.
|
||||
|
||||
In order to enable Barman support for `repmgr standby clone`, you must
|
||||
ensure that:
|
||||
|
||||
- the name of the server configured in Barman is equal to the
|
||||
`cluster_name` setting in `repmgr.conf`;
|
||||
- the `barman_server` setting in `repmgr.conf` is set to the SSH
|
||||
hostname of the Barman server;
|
||||
- the `pg_restore_command` setting in `repmgr.conf` is configured to
|
||||
use a copy of the `barman-wal-restore` script shipped with Barman
|
||||
(see below);
|
||||
- the Barman catalogue includes at least one valid backup for this
|
||||
server.
|
||||
|
||||
> *NOTE*: Barman support is automatically enabled if `barman_server`
|
||||
> is set. Normally this is a good practice; however, the command line
|
||||
> option `--without-barman` can be used to disable it.
|
||||
|
||||
> *NOTE*: if you have a non-default SSH configuration on the Barman
|
||||
> server, e.g. using a port other than 22, then you can set those
|
||||
> parameters in a dedicated Host section in `~/.ssh/config`
|
||||
> corresponding to the value of `barman_server` in `repmgr.conf`. See
|
||||
> the "Host" section in `man 5 ssh_config` for more details.
|
||||
|
||||
`barman-wal-restore` is a short shell script provided by the Barman
|
||||
development team, which must be copied in a location accessible to
|
||||
`repmgr`, and marked as executable; `pg_restore_command` must then be
|
||||
set as follows:
|
||||
|
||||
<script> <Barman hostname> <cluster_name> %f %p
|
||||
|
||||
For instance, suppose that we have installed Barman on the `barmansrv`
|
||||
host, and that we have placed a copy of `barman-wal-restore` into the
|
||||
`/usr/local/bin` directory. First, we ensure that the script is
|
||||
executable:
|
||||
|
||||
sudo chmod +x /usr/local/bin/barman-wal-restore
|
||||
|
||||
Then we check that `repmgr.conf` includes the following lines:
|
||||
|
||||
barman_server=barmansrv
|
||||
pg_restore_command=/usr/local/bin/barman-wal-restore barmansrv test %f %p
|
||||
|
||||
Now we can clone a standby using the Barman server:
|
||||
|
||||
$ repmgr -h node1 -D 9.5/main -f /etc/repmgr.conf standby clone
|
||||
[2016-06-12 20:08:35] [NOTICE] destination directory '9.5/main' provided
|
||||
[2016-06-12 20:08:35] [NOTICE] getting backup from Barman...
|
||||
[2016-06-12 20:08:36] [NOTICE] standby clone (from Barman) complete
|
||||
[2016-06-12 20:08:36] [NOTICE] you can now start your PostgreSQL server
|
||||
[2016-06-12 20:08:36] [HINT] for example : pg_ctl -D 9.5/data start
|
||||
[2016-06-12 20:08:36] [HINT] After starting the server, you need to register this standby with "repmgr standby register"
|
||||
|
||||
Advanced options for cloning a standby
|
||||
--------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user