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.
105 lines
3.1 KiB
Plaintext
105 lines
3.1 KiB
Plaintext
<refentry id="repmgr-primary-register">
|
|
<indexterm>
|
|
<primary>repmgr primary register</primary>
|
|
</indexterm>
|
|
|
|
<refmeta>
|
|
<refentrytitle>repmgr primary register</refentrytitle>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>repmgr primary register</refname>
|
|
<refpurpose>initialise a repmgr installation and register the primary node</refpurpose>
|
|
</refnamediv>
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
<command>repmgr primary register</command> registers a primary node in a
|
|
streaming replication cluster, and configures it for use with &repmgr;, including
|
|
installing the &repmgr; extension. This command needs to be executed before any
|
|
standby nodes are registered.
|
|
</para>
|
|
|
|
<note>
|
|
<para>
|
|
It's possibly to install the &repmgr; extension manually before executing
|
|
<command>repmgr primary register</command>; in this case &repmgr; will
|
|
detect the presence of the extension and skip that step.
|
|
</para>
|
|
</note>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Execution</title>
|
|
<para>
|
|
Execute with the <option>--dry-run</option> option to check what would happen without
|
|
actually registering the primary.
|
|
</para>
|
|
|
|
<note>
|
|
<para>
|
|
If providing the configuration file location with <option>-f/--config-file</option>,
|
|
avoid using a relative path, as &repmgr; stores the configuration file location
|
|
in the repmgr metadata for use when &repmgr; is executed remotely (e.g. during
|
|
<xref linkend="repmgr-standby-switchover"/>). &repmgr; will attempt to convert the
|
|
a relative path into an absolute one, but this may not be the same as the path you
|
|
would explicitly provide (e.g. <filename>./repmgr.conf</filename> might be converted
|
|
to <filename>/path/to/./repmgr.conf</filename>, whereas you'd normally write
|
|
<filename>/path/to/repmgr.conf</filename>).
|
|
</para>
|
|
</note>
|
|
|
|
<para>
|
|
<command>repmgr master register</command> can be used as an alias for
|
|
<command>repmgr primary register</command>.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
|
|
<title>Options</title>
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><option>--dry-run</option></term>
|
|
<listitem>
|
|
<para>
|
|
Check prerequisites but don't actually register the primary.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>-F</option>, <option>--force</option></term>
|
|
<listitem>
|
|
<para>
|
|
Overwrite an existing node record
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 id="repmgr-primary-register-events">
|
|
<title>Event notifications</title>
|
|
<para>
|
|
Following <link linkend="event-notifications">event notifications</link> will be generated:
|
|
<itemizedlist spacing="compact" mark="bullet">
|
|
<listitem>
|
|
<simpara><literal>cluster_created</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>primary_register</literal></simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|