mirror of
https://github.com/EnterpriseDB/repmgr.git
synced 2026-03-22 22:56:29 +00:00
409eb47e2a
This brings the repmgr documentation build system in line with that used by the main PostgreSQL project, and removed the restriction that documentation must be built against PostgreSQL 9.6 or earlier. Main formatting changes are: - convert empty-element tags (mainly <xref/>) - put <indexterm> sections in the correct location - correct usage of various entities.
129 lines
4.3 KiB
Plaintext
129 lines
4.3 KiB
Plaintext
<sect1 id="configuration-file-settings" xreflabel="required configuration file settings">
|
|
|
|
<title>Required configuration file settings</title>
|
|
|
|
<indexterm>
|
|
<primary>repmgr.conf</primary>
|
|
<secondary>required settings</secondary>
|
|
</indexterm>
|
|
|
|
<para>
|
|
Each <filename>repmgr.conf</filename> file must contain the following parameters:
|
|
</para>
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry id="repmgr-conf-node-id" xreflabel="node_id">
|
|
<term><varname>node_id</varname> (<type>int</type>)
|
|
<indexterm>
|
|
<primary><varname>node_id</varname> configuration file parameter</primary>
|
|
</indexterm>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
A unique integer greater than zero which identifies the node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="repmgr-conf-node-name" xreflabel="node_name">
|
|
<term><varname>node_name</varname> (<type>string</type>)
|
|
<indexterm>
|
|
<primary><varname>node_name</varname> configuration file parameter</primary>
|
|
</indexterm>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
An arbitrary (but unique) string; we recommend using the server's hostname
|
|
or another identifier unambiguously associated with the server to avoid
|
|
confusion. Avoid choosing names which reflect the node's current role,
|
|
e.g. <varname>primary</varname> or <varname>standby1</varname>
|
|
as roles can change and if you end up in a solution where the current primary is
|
|
called <varname>standby1</varname> (for example), things will be confusing
|
|
to say the least.
|
|
</para>
|
|
<para>
|
|
The string's maximum length is 63 characters and it should
|
|
contain only printable ASCII characters.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="repmgr-conf-conninfo" xreflabel="conninfo">
|
|
<term><varname>conninfo</varname> (<type>string</type>)
|
|
<indexterm>
|
|
<primary><varname>conninfo</varname> configuration file parameter</primary>
|
|
</indexterm>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Database connection information as a conninfo string.
|
|
All servers in the cluster must be able to connect to
|
|
the local node using this string.
|
|
</para>
|
|
<para>
|
|
For details on conninfo strings, see section <ulink
|
|
url="https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING">Connection Strings</ulink>
|
|
in the PosgreSQL documentation.
|
|
</para>
|
|
<para>
|
|
If repmgrd is in use, consider explicitly setting
|
|
<varname>connect_timeout</varname> in the <varname>conninfo</varname>
|
|
string to determine the length of time which elapses before a network
|
|
connection attempt is abandoned; for details see <ulink
|
|
url="https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-CONNECT-TIMEOUT">
|
|
the PostgreSQL documentation</ulink>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="repmgr-conf-data-directory" xreflabel="data_directory">
|
|
<term><varname>data_directory</varname> (<type>string</type>)</term>
|
|
<listitem>
|
|
<indexterm>
|
|
<primary><varname>data_directory</varname> configuration file parameter</primary>
|
|
</indexterm>
|
|
|
|
<para>
|
|
The node's data directory. This is needed by repmgr
|
|
when performing operations when the PostgreSQL instance
|
|
is not running and there's no other way of determining
|
|
the data directory.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
|
|
</variablelist>
|
|
</para>
|
|
|
|
<para>
|
|
For a full list of annotated configuration items, see the file
|
|
<ulink url="https://raw.githubusercontent.com/2ndQuadrant/repmgr/master/repmgr.conf.sample">repmgr.conf.sample</ulink>.
|
|
</para>
|
|
<para>
|
|
For &repmgrd;-specific settings, see <xref linkend="repmgrd-configuration"/>.
|
|
</para>
|
|
|
|
<note>
|
|
<para>
|
|
The following parameters in the configuration file can be overridden with
|
|
command line options:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>-L/--log-level</literal> overrides <literal>log_level</literal> in
|
|
<filename>repmgr.conf</filename>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>-b/--pg_bindir</literal> overrides <literal>pg_bindir</literal> in
|
|
<filename>repmgr.conf</filename>
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</note>
|
|
|
|
</sect1>
|