diff --git a/doc/repmgr-witness-register.sgml b/doc/repmgr-witness-register.sgml new file mode 100644 index 00000000..efe2526e --- /dev/null +++ b/doc/repmgr-witness-register.sgml @@ -0,0 +1,51 @@ + + + repmgr witness register + + + + repmgr witness register + + + + repmgr witness register + add a witness node's information to the &repmgr; metadata + + + + Description + + repmgr witness register adds a witness server's node + record to the &repmgr; metadata, and if necessary initialises the witness + node by installing the &repmgr; extension and copying the &repmgr; metadata + to the witness server. This command needs to be executed to enable + use of the witness server with repmgrd. + + + When executing repmgr witness register, connection information + for the cluster primary server must also be provided. &repmgr; will automatically + use the user and dbname values defined + in the conninfo string defined in the witness node's + repmgr.conf, if these are not explicitly provided. + + + Execute with the --dry-run option to check what would happen + without actually registering the witness server. + + + + Example + + + $ repmgr -f /etc/repmgr.conf witness register -h node1 + INFO: connecting to witness node "node3" (ID: 3) + INFO: connecting to primary node + NOTICE: attempting to install extension "repmgr" + NOTICE: "repmgr" extension successfully installed + INFO: witness registration complete + NOTICE: witness node "node3" (ID: 3) successfully registered + + + + + diff --git a/doc/repmgr-witness-unregister.sgml b/doc/repmgr-witness-unregister.sgml new file mode 100644 index 00000000..bd9a9416 --- /dev/null +++ b/doc/repmgr-witness-unregister.sgml @@ -0,0 +1,64 @@ + + + repmgr witness unregister + + + + repmgr witness unregister + + + + repmgr witness unregister + remove a witness node's information to the &repmgr; metadata + + + + Description + + repmgr witness unregister removes a witness server's node + record from the &repmgr; metadata. + + + The node does not have to be running to be unregistered, however if this is the + case then connection information for the primary server must be provided. + + + Execute with the --dry-run option to check what would happen + without actually registering the witness server. + + + + Examples + + Unregistering a running witness node: + + $ ./repmgr -f /space/sda1/ibarwick/repmgr-test/node_3/repmgr.conf witness unregister + INFO: connecting to witness node "node3" (ID: 3) + INFO: unregistering witness node 3 + INFO: witness unregistration complete + DETAIL: witness node with id 3 (conninfo: host=node3 dbname=repmgr user=repmgr port=5499) successfully unregistered + + + Unregistering a non-running witness node: + + $ ./repmgr -f /space/sda1/ibarwick/repmgr-test/node_3/repmgr.conf witness unregister -h localhost -p 5501 -F + INFO: connecting to witness node "node3" (ID: 3) + NOTICE: unable to connect to witness node "node3" (ID: 3), removing node record on cluster primary only + INFO: unregistering witness node 3 + INFO: witness unregistration complete + DETAIL: witness node with id 3 (conninfo: host=node3 dbname=repmgr user=repmgr port=5499) successfully unregistered + + + + + Notes + + This command will not make any changes to the witness node itself and will neither + remove any data from the witness database nor stop the PostgreSQL instance. + + + A witness node which has been unregistered, can be re-registered with + repmgr witness register --force. + + +