diff --git a/doc/repmgr-standby-follow.sgml b/doc/repmgr-standby-follow.sgml index 6183452b..86956568 100644 --- a/doc/repmgr-standby-follow.sgml +++ b/doc/repmgr-standby-follow.sgml @@ -9,23 +9,19 @@ repmgr standby follow - attach a standby to a new primary + attach a running standby to a new upstream node Description - Attaches the standby to a new primary. This command requires a valid + Attaches the standby to a new upstream node. This command requires a valid repmgr.conf file for the standby, either specified explicitly with -f/--config-file or located in a default location; no additional arguments are required. - - This command will force a restart of the standby server, which must be - running. It can only be used to attach an active standby to the current primary node - (and not to another standby). - + To re-add an inactive node to the replication cluster, use @@ -33,6 +29,23 @@ + + This command will force a restart of the standby server, which must be + running. Additionally, in order to be able to verify whether the standby + can attach to the upstream node, a CHECKPOINT will + be executed - this requires superuser privileges, and will be executed + even with the option. + + + + + If the &repmgr; database user is not a superuser, it will not be possible + to execute CHECKPOINT, meaning &repmgr; may not be + able to determine whether the upstream node can be followed. + + + + repmgr standby follow will wait up to standby_follow_timeout seconds (default: 30) @@ -108,6 +121,44 @@ + + Exit codes + + Following exit codes can be emitted by repmgr standby follow: + + + + + + + + No issues were detected. + + + + + + + + + &repmgr; was unable to establish a database connection to one of the nodes. + + + + + + + + + &repmgr; was unable to complete the follow command. + + + + + + + + Event notifications @@ -127,4 +178,3 @@ -