From 22f2ee3050d75cc2f554ba9af9215dddd5e6e722 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mart=C3=ADn=20Marqu=C3=A9s?=
 <martin.marques@2ndquadrant.com>
Date: Wed, 5 Aug 2020 17:54:25 -0300
Subject: [PATCH] doc: add two notes on section related to configuration files
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Add notes to the documention mentioning that after postgres or repmgr
upgrades (postgres major upgrades), there are some changes that need
to be taken care of.

Signed-off-by: Martín Marqués <martin.marques@2ndquadrant.com>
---
 doc/configuration-file.xml | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/doc/configuration-file.xml b/doc/configuration-file.xml
index 2a55e055..0ecbcc55 100644
--- a/doc/configuration-file.xml
+++ b/doc/configuration-file.xml
@@ -211,5 +211,29 @@ conninfo='host=node1 user=repmgr dbname=repmgr connect_timeout=2'</programlistin
     </para>
    </note>
 
+   <note>
+     <para>
+       When upgrading the PostgreSQL cluster to a new major version, updating the &repmgr; configuration file
+       may be needed. In particular, if default package locations for <option>pg_bindir</option> and
+       <option>data_directory</option> are used, both these options in <filename>repmgr.conf</filename>
+       will need to be updated accordingly.
+       </para>
+   </note>
+
+   <note>
+     <para>
+       If the location of the configuration file changed after a PostgreSQL major upgrade, the
+       <option>config_file</option> field from the <structname>repmgr.nodes</structname> table will
+       need to reflect this change. This can be accomplished by forcing all nodes to register
+       again with the new configuration file. This will effectively update the <option>config_file</option>
+       field in <structname>repmgr.nodes</structname>. To accomplished this, just
+       execute <link linkend="repmgr-primary-register">
+       <command>repmgr primary register --force -f /path/to/repmgr.conf</command></link>
+       on the primary node, and then <link linkend="repmgr-standby-register">
+       <command>repmgr standby register --force -f /path/to/repmgr.conf</command></link>
+       on all the standby nodes (don't forget the witness, if there is one).
+     </para>
+   </note>
+
    </sect2>
  </sect1>