github/repmgr
1
0
Fork 0
mirror of https://github.com/EnterpriseDB/repmgr.git synced 2026-03-23 07:06:30 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Update configuration file settings

Browse Source
This commit is contained in:
Ian Barwick
2017-09-13 09:45:08 +09:00
committed by Ian Barwick
parent 4ab081ba41
commit 9a94878c73
1 changed files with 84 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
doc/configuration-file-settings.sgml
View File

@@ -1,8 +1,89 @@
<sect1 id="configuration-file-settings" xreflabel="configuration file settings">
<title>Configuration file settings</title>
<para>
<title>Configuration file settings</title>
<para>
Each repmgr.conf 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 it will be confusing if e.g. the current primary is
called <varname>standby1</varname>.
</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/static/libpq-connect.html#LIBPQ-CONNSTRING">
Connection Strings</> 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/static/libpq-connect.html#LIBPQ-CONNECT-CONNECT-TIMEOUT">
the PostgreSQL documentation</>.
</para>
</listitem>
</varlistentry>
<varlistentry id="repmgr-conf-data-directory" xreflabel="data_directory">
<term><varname>data_directory</varname> (<type>data_directory</type>)
<indexterm>
<primary><varname>data_directory</varname> configuration file parameter</primary>
</indexterm>
</term>
<listitem>
<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>
<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</>.