diff --git a/doc/repmgr-node-rejoin.sgml b/doc/repmgr-node-rejoin.sgml index 14d9f8b7..37687f6b 100644 --- a/doc/repmgr-node-rejoin.sgml +++ b/doc/repmgr-node-rejoin.sgml @@ -6,8 +6,41 @@ Enables a dormant (stopped) node to be rejoined to the replication cluster. + + + Currently repmgr node rejoin can only be used to attach + a standby to the current primary, not another standby. + + This can optionally use pg_rewind to re-integrate a node which has diverged from the rest of the cluster, typically a failed primary. + + The node must have been shut down cleanly; if this was not the case, it will + need to be manually started (remove any existing recovery.conf file) until + it has reached a consistent recovery point, then shut down cleanly. + + + Usage: + + repmgr node rejoin -d '$conninfo' + + where $conninfo is the conninfo string of any reachable node in the cluster. + repmgr.conf for the stopped node *must* be supplied explicitly if not + otherwise available. + + + repmgr node rejoin can optionally use pg_rewind to re-integrate a + node which has diverged from the rest of the cluster, typically a failed primary. + pg_rewind is available in PostgreSQL 9.5 and later. + + + + pg_rewind *requires* that either wal_log_hints is enabled, or that + data checksums were enabled when the cluster was initialized. See the + pg_rewind documentation for details. + + +