github/repmgr
1
0
Fork 0
mirror of https://github.com/EnterpriseDB/repmgr.git synced 2026-03-27 00:46:29 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

doc: improve instructions for cloning from Barman

Browse Source
This commit is contained in:
Ian Barwick
2019-10-07 11:56:40 +09:00
parent b885337abc
commit ea57269569
1 changed files with 47 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
doc/cloning-standbys.xml
View File

@@ -78,8 +78,7 @@
<itemizedlist spacing="compact" mark="bullet"> <itemizedlist spacing="compact" mark="bullet">
<listitem> <listitem>
<para> <para>
the <varname>barman_server</varname> setting in <filename>repmgr.conf</filename> is the same as the the Barman catalogue must include at least one valid backup for this server;
server configured in Barman;
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@@ -90,28 +89,40 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
the <varname>restore_command</varname> setting in <filename>repmgr.conf</filename> is configured to the <varname>barman_server</varname> setting in <filename>repmgr.conf</filename> is the same as the
use the <command>barman-wal-restore</command> script server configured in Barman.
(see section <xref linkend="cloning-from-barman-restore-command"/>
below).
</para>
</listitem>
<listitem>
<para>
the Barman catalogue includes at least one valid backup for this server.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para>
For example, assuming Barman is located on the host &quot;<literal>barmansrv</literal>&quot;
under the &quot;<literal>barman</literal>&quot; user account,
<filename>repmgr.conf</filename> should contain the following entries:
<programlisting>
barman_host=barman@barmansrv
barman_server=somedb</programlisting>
</para>
<note> <note>
<simpara> <para>
Barman support is automatically enabled if <varname>barman_server</varname> To use a non-default Barman configuration file on the Barman server,
is set. Normally it is good practice to use Barman, for instance specify this in <filename>repmgr.conf</filename> with <filename>barman_config</filename>:
when fetching a base backup while cloning a standby; in any case, <programlisting>
Barman mode can be disabled using the <literal>--without-barman</literal> barman_config=/path/to/barman.conf</programlisting>
command line option. </para>
</simpara>
</note> </note>
<para>
We also recommend configuring the <varname>restore_command</varname> setting in <filename>repmgr.conf</filename>
to use the <command>barman-wal-restore</command> script
(see section <xref linkend="cloning-from-barman-restore-command"/> below).
</para>
<tip> <tip>
<simpara> <simpara>
If you have a non-default SSH configuration on the Barman If you have a non-default SSH configuration on the Barman
@@ -139,6 +150,17 @@
NOTICE: you can now start your PostgreSQL server NOTICE: you can now start your PostgreSQL server
HINT: for example: pg_ctl -D /var/lib/postgresql/data start</programlisting> HINT: for example: pg_ctl -D /var/lib/postgresql/data start</programlisting>
</para> </para>
<note>
<simpara>
Barman support is automatically enabled if <varname>barman_server</varname>
is set. Normally it is good practice to use Barman, for instance
when fetching a base backup while cloning a standby; in any case,
Barman mode can be disabled using the <literal>--without-barman</literal>
command line option.
</simpara>
</note>
</sect2> </sect2>
<sect2 id="cloning-from-barman-restore-command" xreflabel="Using Barman as a WAL file source"> <sect2 id="cloning-from-barman-restore-command" xreflabel="Using Barman as a WAL file source">
<title>Using Barman as a WAL file source</title> <title>Using Barman as a WAL file source</title>
@@ -159,31 +181,25 @@
package (Barman 2.0 ~ 2.7) or as part of the core Barman distribution (Barman 2.8 and later). package (Barman 2.0 ~ 2.7) or as part of the core Barman distribution (Barman 2.8 and later).
</para> </para>
<para> <para>
To use <command>barman-wal-restore</command> with &repmgr; To use <command>barman-wal-restore</command> with &repmgr;,
and assuming Barman is located on the <literal>barmansrv</literal> host assuming Barman is located on the host &quot;<literal>barmansrv</literal>&quot;
under the &quot;<literal>barman</literal>&quot; user account,
and that <command>barman-wal-restore</command> is located as an executable at and that <command>barman-wal-restore</command> is located as an executable at
<filename>/usr/bin/barman-wal-restore</filename>, <filename>/usr/bin/barman-wal-restore</filename>,
<filename>repmgr.conf</filename> should include the following lines: <filename>repmgr.conf</filename> should include the following lines:
<programlisting> <programlisting>
barman_host=barmansrv barman_host=barman@barmansrv
barman_server=somedb barman_server=somedb
restore_command=/usr/bin/barman-wal-restore barmansrv somedb %f %p</programlisting> restore_command=/usr/bin/barman-wal-restore barmansrv somedb %f %p</programlisting>
</para> </para>
<note> <note>
<simpara> <simpara>
<command>barman-wal-restore</command> supports command line switches to <command>barman-wal-restore</command> supports command line switches to
control parallelism (<literal>--parallel=N</literal>) and compression ( control parallelism (<literal>--parallel=N</literal>) and compression
<literal>--bzip2</literal>, <literal>--gzip</literal>). (<literal>--bzip2</literal>, <literal>--gzip</literal>).
</simpara> </simpara>
</note> </note>
<note>
<para>
To use a non-default Barman configuration file on the Barman server,
specify this in <filename>repmgr.conf</filename> with <filename>barman_config</filename>:
<programlisting>
barman_config=/path/to/barman.conf</programlisting>
</para>
</note>
</sect2> </sect2>
</sect1> </sect1>