mirror of
https://github.com/EnterpriseDB/repmgr.git
synced 2026-03-26 16:46:28 +00:00
a965bc005f
Make it clearer that a) the primary server's hostname is required, and b) how to provide it. Based on feedback provided in GitHub #529.
66 lines
2.4 KiB
Plaintext
66 lines
2.4 KiB
Plaintext
<refentry id="repmgr-witness-register">
|
|
<indexterm>
|
|
<primary>repmgr witness register</primary>
|
|
<seealso>witness server</seealso>
|
|
</indexterm>
|
|
|
|
<refmeta>
|
|
<refentrytitle>repmgr witness register</refentrytitle>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>repmgr witness register</refname>
|
|
<refpurpose>add a witness node's information to the &repmgr; metadata</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
<command>repmgr witness register</command> adds a witness server's node
|
|
record to the &repmgr; metadata, and if necessary initialises the witness
|
|
node by installing the &repmgr; extension and copying the &repmgr; metadata
|
|
to the witness server. This command needs to be executed to enable
|
|
use of the witness server with <application>repmgrd</application>.
|
|
</para>
|
|
<para>
|
|
When executing <command>repmgr witness register</command>, database connection
|
|
information for the cluster primary server must also be provided.
|
|
</para>
|
|
<para>
|
|
In most cases it's only necessary to provide the primary's hostname with
|
|
the <option>-h</option>/<option>--hostname</option> option; &repmgr; will
|
|
automatically use the <varname>user</varname> and <varname>dbname</varname>
|
|
values defined in the <varname>conninfo</varname> string defined in the
|
|
witness node's <filename>repmgr.conf</filename>, unless these are explicitly
|
|
provided as command line options.
|
|
</para>
|
|
<para>
|
|
Execute with the <option>--dry-run</option> option to check what would happen
|
|
without actually registering the witness server.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Example</title>
|
|
<para>
|
|
<programlisting>
|
|
$ repmgr -f /etc/repmgr.conf witness register -h node1
|
|
INFO: connecting to witness node "node3" (ID: 3)
|
|
INFO: connecting to primary node
|
|
NOTICE: attempting to install extension "repmgr"
|
|
NOTICE: "repmgr" extension successfully installed
|
|
INFO: witness registration complete
|
|
NOTICE: witness node "node3" (ID: 3) successfully registered
|
|
</programlisting>
|
|
</para>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 id="repmgr-witness-register-events">
|
|
<title>Event notifications</title>
|
|
<para>
|
|
A <literal>witness_register</literal> <link linkend="event-notifications">event notification</link> will be generated.
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|