From 35c8bb4e757e9d557056f3f781d59e491a53fbf2 Mon Sep 17 00:00:00 2001 From: Ian Barwick Date: Thu, 19 Oct 2017 16:21:59 +0900 Subject: [PATCH] docs: update "repmgr cluster show" page --- doc/repmgr-cluster-show.sgml | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/doc/repmgr-cluster-show.sgml b/doc/repmgr-cluster-show.sgml index 823c5668..58f8203b 100644 --- a/doc/repmgr-cluster-show.sgml +++ b/doc/repmgr-cluster-show.sgml @@ -14,7 +14,6 @@ This command requires either a valid repmgr.conf file or a database connection string to one of the registered nodes; no additional arguments are needed. - Example: @@ -31,8 +30,26 @@ To show database connection errors when polling nodes, run the command in --verbose mode. + - cluster show accepts an optional parameter --csv, which + Note that the column Role shows the expected server role according to the + &repmgr; metadata. Status shows whether the server is running or unreachable. + If the node has an unexpected role not reflected in the &repmgr; metadata, e.g. a node was manually + promoted to primary, this will be highlighted with an exclamation mark, e.g.: + + ID | Name | Role | Status | Upstream | Location | Connection string + ----+-------+---------+----------------------+----------+----------+----------------------------------------- + 1 | node1 | primary | ? unreachable | | default | host=db_node1 dbname=repmgr user=repmgr + 2 | node2 | standby | ! running as primary | node1 | default | host=db_node2 dbname=repmgr user=repmgr + 3 | node3 | standby | running | node1 | default | host=db_node3 dbname=repmgr user=repmgr + + WARNING: following issues were detected + node "node1" (ID: 1) is registered as an active primary but is unreachable + node "node2" (ID: 2) is registered as standby but running as primary + + + + repmgr cluster show accepts an optional parameter --csv, which outputs the replication cluster's status in a simple CSV format, suitable for parsing by scripts: