From 6b70e8bbe650da381e698144a6cc86ff0cbad6c2 Mon Sep 17 00:00:00 2001
From: Ian Barwick <ian@2ndquadrant.com>
Date: Mon, 8 Jan 2018 11:13:39 +0900
Subject: [PATCH] doc: list repmgr.conf parameters relevant during switchover

---
 doc/switchover.sgml | 33 ++++++++++++++++++++++++++++++---
 1 file changed, 30 insertions(+), 3 deletions(-)

diff --git a/doc/switchover.sgml b/doc/switchover.sgml
index ec834102..e4512f2b 100644
--- a/doc/switchover.sgml
+++ b/doc/switchover.sgml
@@ -55,7 +55,7 @@
    </indexterm>
    <title>Preparing for switchover</title>
    <para>
-    As mentioned above, success of the switchover operation depends on &repmgr;
+    Success of the switchover operation depends on &repmgr;
     being able to shut down the current primary server quickly and cleanly.
    </para>
    <para>
@@ -64,8 +64,7 @@
     <programlisting>
      repmgr -f /etc/repmgr.conf node service --list --action=stop
      repmgr -f /etc/repmgr.conf node service --list --action=start
-     repmgr -f /etc/repmgr.conf node service --list --action=restart
-    </programlisting>
+     repmgr -f /etc/repmgr.conf node service --list --action=restart</programlisting>
    </para>
    <note>
     <simpara>
@@ -115,6 +114,34 @@
         "pg_ctl -l /var/log/postgresql/startup.log -D '/var/lib/postgresql/data' -m fast -W stop"
     </programlisting>
    </para>
+   <para>
+     Note that following parameters in <filename>repmgr.conf</filename> are relevant to the
+     switchover operation:
+     <itemizedlist spacing="compact" mark="bullet">
+       <listitem>
+         <simpara>
+           <literal>reconnect_attempts</literal>: number of times to check the original primary
+           for a clean shutdown after executing the shutdown command, before aborting
+         </simpara>
+       </listitem>
+       <listitem>
+         <simpara>
+           <literal>reconnect_interval</literal>: interval (in seconds) to check the original
+           primary for a clean shutdown after executing the shutdown command (up to a maximum
+           of <literal>reconnect_attempts</literal> tries)
+         </simpara>
+       </listitem>
+       <listitem>
+         <simpara>
+           <literal>replication_lag_critical</literal>:
+           if replication lag (in seconds) on the standby exceeds this value, the
+           switchover will be aborted (unless the <literal>-F/--force</literal> option
+           is provided)
+         </simpara>
+       </listitem>
+
+     </itemizedlist>
+   </para>
  </sect1>
 
  <sect1 id="switchover-execution" xreflabel="Executing the switchover command">