mirror of
https://github.com/EnterpriseDB/repmgr.git
synced 2026-03-23 15:16:29 +00:00
4d4ed3bcd6
The BDR 2.x support was conceptual only and was never used in production. As BDR 2.x will be EOL'd shortly, there is no risk it will be needed.
137 lines
4.8 KiB
XML
137 lines
4.8 KiB
XML
<sect1 id="configuration-file-optional-settings" xreflabel="optional configuration file settings">
|
|
|
|
<title>Optional configuration file settings</title>
|
|
|
|
<indexterm>
|
|
<primary>repmgr.conf</primary>
|
|
<secondary>optional settings</secondary>
|
|
</indexterm>
|
|
|
|
<variablelist>
|
|
|
|
|
|
<varlistentry id="repmgr-conf-config-directory" xreflabel="config_directory">
|
|
<term><varname>config_directory</varname> (<type>string</type>)
|
|
<indexterm>
|
|
<primary><varname>config_directory</varname> configuration file parameter</primary>
|
|
</indexterm>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
If PostgreSQL configuration files are located outside the data
|
|
directory, specify the directory where the main
|
|
<filename>postgresql.conf</filename> file is located.
|
|
</para>
|
|
<para>
|
|
This enables explicit provision of an external configuration file
|
|
directory, which if set will be passed to <command>pg_ctl</command> as the
|
|
<option>-D</option> parameter. Otherwise <command>pg_ctl</command> will
|
|
default to using the data directory, which will cause some operations
|
|
to fail if the configuration files are not present there.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
This is implemented primarily for feature completeness and for
|
|
development/testing purposes. Users who have installed &repmgr; from
|
|
a package should <emphasis>not</emphasis> rely on to stop/start/restart PostgreSQL,
|
|
instead they should set the appropriate <option>service_..._command</option>
|
|
for their operating system. For more details see
|
|
<xref linkend="configuration-file-service-commands"/>.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="repmgr-conf-replication-user" xreflabel="replication_user">
|
|
<term><varname>replication_user</varname> (<type>string</type>)
|
|
<indexterm>
|
|
<primary><varname>replication_user</varname> configuration file parameter</primary>
|
|
</indexterm>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
PostgreSQL user to make replication connections with.
|
|
If not set defaults, to the user defined in <xref linkend="repmgr-conf-conninfo"/>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry id="repmgr-conf-replication-type" xreflabel="replication_type">
|
|
<term><varname>replication_type</varname> (<type>string</type>)
|
|
<indexterm>
|
|
<primary><varname>replication_type</varname> configuration file parameter</primary>
|
|
</indexterm>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Must be <literal>physical</literal> (the default).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="repmgr-conf-location" xreflabel="location">
|
|
<term><varname>location</varname> (<type>string</type>)
|
|
<indexterm>
|
|
<primary><varname>location</varname> configuration file parameter</primary>
|
|
</indexterm>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
An arbitrary string defining the location of the node; this
|
|
is used during failover to check visibility of the
|
|
current primary node.
|
|
</para>
|
|
<para>
|
|
For more details see <xref linkend="repmgrd-network-split"/>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="repmgr-conf-use-replication-slots" xreflabel="use_replication_slots">
|
|
<term><varname>use_replication_slots</varname> (<type>boolean</type>)
|
|
<indexterm>
|
|
<primary><varname>use_replication_slots</varname> configuration file parameter</primary>
|
|
</indexterm>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Whether to use physical replication slots.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
When using replication slots,
|
|
<varname>max_replication_slots</varname> should be configured for
|
|
at least the number of standbys which will connect
|
|
to the primary.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="repmgr-conf-ssh-options" xreflabel="ssh_options">
|
|
<term><varname>ssh_options</varname> (<type>string</type>)
|
|
<indexterm>
|
|
<primary><varname>ssh_options</varname> configuration file parameter</primary>
|
|
</indexterm>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Options to append to the <command>ssh</command> command when executed
|
|
by &repmgr;.
|
|
</para>
|
|
<para>
|
|
We recommend adding <literal>-q</literal> to suppress any superfluous
|
|
SSH chatter such as login banners, and also an explicit
|
|
<option>ConnectTimeout</option> value,
|
|
e.g.:
|
|
<programlisting>
|
|
ssh_options='-q -o ConnectTimeout=10'</programlisting>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect1>
|