doc: document "node_rejoin_timeout" for switchover operations

This commit is contained in:
Ian Barwick
2019-01-30 15:43:34 +09:00
parent d4ee4cc14c
commit 9349171b55
3 changed files with 100 additions and 29 deletions

View File

@@ -70,6 +70,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-w</option></term>
<term><option>--wait</option></term> <term><option>--wait</option></term>
<listitem> <listitem>
<para> <para>

View File

@@ -78,7 +78,8 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-w/--wait</option></term> <term><option>-w</option></term>
<term><option>--wait</option></term>
<listitem> <listitem>
<para> <para>
Wait for the specified number of seconds to confirm that <application>repmgrd</application> Wait for the specified number of seconds to confirm that <application>repmgrd</application>

View File

@@ -146,6 +146,7 @@
<varlistentry> <varlistentry>
<term><option>--siblings-follow</option></term> <term><option>--siblings-follow</option></term>
<listitem> <listitem>
<para> <para>
@@ -163,27 +164,57 @@
<para> <para>
Note that following parameters in <filename>repmgr.conf</filename> are relevant to the Note that following parameters in <filename>repmgr.conf</filename> are relevant to the
switchover operation: switchover operation:
<itemizedlist spacing="compact" mark="bullet"> </para>
<variablelist>
<varlistentry>
<indexterm>
<primary>x</primary>
<secondary>with &quot;repmgr standby switchover &quot;</secondary>
</indexterm>
<term><option></option></term>
<listitem> <listitem>
<simpara> <para>
<literal>replication_lag_critical</literal>: </para>
if replication lag (in seconds) on the standby exceeds this value, the </listitem>
</varlistentry>
<varlistentry>
<indexterm>
<primary>replication_lag_critical</primary>
<secondary>with &quot;repmgr standby switchover &quot;</secondary>
</indexterm>
<term><option>replication_lag_critical</option></term>
<listitem>
<para>
If replication lag (in seconds) on the standby exceeds this value, the
switchover will be aborted (unless the <literal>-F/--force</literal> option switchover will be aborted (unless the <literal>-F/--force</literal> option
is provided) is provided)
</simpara> </para>
</listitem> </listitem>
</varlistentry>
<varlistentry>
<indexterm>
<primary>shutdown_check_timeout</primary>
<secondary>with &quot;repmgr standby switchover &quot;</secondary>
</indexterm>
<term><option>shutdown_check_timeout</option></term>
<listitem> <listitem>
<simpara> <para>
<literal>shutdown_check_timeout</literal>: maximum number of seconds to wait for the maximum number of seconds to wait for the
demotion candidate (current primary) to shut down, before aborting the switchover. demotion candidate (current primary) to shut down, before aborting the switchover.
</simpara> </para>
<simpara> <para>
Note that this parameter is set on the node where <command>repmgr standby switchover</command> Note that this parameter is set on the node where <command>repmgr standby switchover</command>
is executed (promotion candidate); setting it on the demotion candidate (former primary) will is executed (promotion candidate); setting it on the demotion candidate (former primary) will
have no effect. have no effect.
</simpara> </para>
<note> <note>
<para> <para>
In versions prior to <link linkend="release-4.2">&repmgr; 4.2</link>, <command>repmgr standby switchover</command> would In versions prior to <link linkend="release-4.2">&repmgr; 4.2</link>, <command>repmgr standby switchover</command> would
@@ -192,17 +223,55 @@
</para> </para>
</note> </note>
</listitem> </listitem>
</varlistentry>
<varlistentry>
<indexterm>
<primary>standby_reconnect_timeout</primary>
<secondary>with &quot;repmgr standby switchover &quot;</secondary>
</indexterm>
<term><option>standby_reconnect_timeout</option></term>
<listitem> <listitem>
<simpara> <para>
<literal>standby_reconnect_timeout</literal>:
maximum number of seconds to attempt to wait for the demotion candidate (former primary) maximum number of seconds to attempt to wait for the demotion candidate (former primary)
to reconnect to the promoted primary (default: 60 seconds) to reconnect to the promoted primary (default: 60 seconds)
</simpara>
</listitem>
</itemizedlist>
</para> </para>
<para>
Note that this parameter is set on the node where <command>repmgr standby switchover</command>
is executed (promotion candidate); setting it on the demotion candidate (former primary) will
have no effect.
</para>
</listitem>
</varlistentry>
<varlistentry>
<indexterm>
<primary>node_rejoin_timeout</primary>
<secondary>with &quot;repmgr standby switchover &quot;</secondary>
</indexterm>
<term><option>node_rejoin_timeout</option></term>
<listitem>
<para>
maximum number of seconds to attempt to wait for the demotion candidate (former primary)
to reconnect to the promoted primary (default: 60 seconds)
</para>
<para>
Note that this parameter is set on the the demotion candidate (former primary);
setting it on the node where <command>repmgr standby switchover</command> is
executed will have no effect.
</para>
<para>
However, this value <emphasis>must</emphasis> be less than <option>standby_reconnect_timeout</option> on the
promotion candidate (node where <command>repmgr standby switchover</command> is executed).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1> </refsect1>