From 19190153a079c86ede785e233c6f562aa3377e61 Mon Sep 17 00:00:00 2001
From: Ian Barwick <ian@2ndquadrant.com>
Date: Fri, 30 Aug 2019 12:07:37 +0900
Subject: [PATCH] doc: clarify prerequisites for executing the "repmgr service"
 commands

Note node accessibility requirements on each command's reference
page.
---
 doc/repmgr-service-pause.xml   |  9 +++++++++
 doc/repmgr-service-status.xml  | 16 ++++++++++++++--
 doc/repmgr-service-unpause.xml |  9 +++++++++
 3 files changed, 32 insertions(+), 2 deletions(-)

diff --git a/doc/repmgr-service-pause.xml b/doc/repmgr-service-pause.xml
index 6a51ce99..78f59478 100644
--- a/doc/repmgr-service-pause.xml
+++ b/doc/repmgr-service-pause.xml
@@ -42,6 +42,15 @@
     </para>
   </refsect1>
 
+  <refsect1>
+    <title>Prerequisites</title>
+    <para>
+      PostgreSQL must be accessible on all nodes (using the <varname>conninfo</varname> string shown by
+      <link linkend="repmgr-cluster-show"><command>repmgr cluster show</command></link>)
+      from the node where <command>repmgr service pause</command> is executed.
+    </para>
+  </refsect1>
+
   <refsect1>
     <title>Execution</title>
     <para>
diff --git a/doc/repmgr-service-status.xml b/doc/repmgr-service-status.xml
index 92857593..29673031 100644
--- a/doc/repmgr-service-status.xml
+++ b/doc/repmgr-service-status.xml
@@ -27,6 +27,15 @@
     </para>
   </refsect1>
 
+  <refsect1>
+    <title>Prerequisites</title>
+    <para>
+      PostgreSQL should be accessible on all nodes (using the <varname>conninfo</varname> string shown by
+      <link linkend="repmgr-cluster-show"><command>repmgr cluster show</command></link>)
+      from the node where <command>repmgr service status</command> is executed.
+    </para>
+  </refsect1>
+
   <refsect1>
     <title>Execution</title>
     <para>
@@ -34,9 +43,12 @@
       replication cluster. A valid <filename>repmgr.conf</filename> file is required.
     </para>
     <para>
-      If PostgreSQL is not running on a node, &repmgr; will not be able to determine the
-      status of that node's &repmgrd; instance.
+      If a node is not accessible, or PostgreSQL itself is not running on the node,
+      &repmgr; will not be able to determine the status of that node's &repmgrd; instance,
+      and &quot;<literal>n/a</literal>&quot; will be displayed in the node's <literal>repmgrd</literal>
+      column.
     </para>
+
     <note>
       <para>
         After restarting PostgreSQL on any node, the &repmgrd; instance
diff --git a/doc/repmgr-service-unpause.xml b/doc/repmgr-service-unpause.xml
index 77d9dea1..5ccbcc03 100644
--- a/doc/repmgr-service-unpause.xml
+++ b/doc/repmgr-service-unpause.xml
@@ -36,6 +36,15 @@
 
   </refsect1>
 
+  <refsect1>
+    <title>Prerequisites</title>
+    <para>
+      PostgreSQL must be accessible on all nodes (using the <varname>conninfo</varname> string shown by
+      <link linkend="repmgr-cluster-show"><command>repmgr cluster show</command></link>)
+      from the node where <command>repmgr service pause</command> is executed.
+    </para>
+  </refsect1>
+
   <refsect1>
     <title>Execution</title>
     <para>