Update hroller man page: master node is last
authorKlaus Aehlig <aehlig@google.com>
Wed, 17 Apr 2013 11:13:17 +0000 (13:13 +0200)
committerKlaus Aehlig <aehlig@google.com>
Fri, 19 Apr 2013 11:54:48 +0000 (13:54 +0200)
Where the information is available, hroller now schedules the
master node as the last node in the last group. Update the man
page to reflect this change.

Signed-off-by: Klaus Aehlig <aehlig@google.com>
Reviewed-by: Guido Trotter <ultrotter@google.com>

man/hroller.rst

index 67181f3..c381a0a 100644 (file)
@@ -37,6 +37,10 @@ hroller is a cluster maintenance reboot scheduler. It can calculate
 which set of nodes can be rebooted at the same time while avoiding
 having both primary and secondary nodes being rebooted at the same time.
 
+For backends that support identifying the master node (currenlty
+RAPI and LUXI), the master node is scheduled as the last node
+in the last reboot group.
+
 ALGORITHM FOR CALCULATING OFFLINE REBOOT GROUPS
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -56,9 +60,6 @@ check **htools**\(7) and **hbal**\(1).
 BUGS
 ----
 
-The master node should be always the last node of the last group, or anyway
-somehow easily identifiable. Right now this is not done.
-
 Offline nodes should be ignored.
 
 If instances are online the tool should refuse to do offline rolling
@@ -73,15 +74,14 @@ should support them both with and without secondary node replacement.
 EXAMPLE
 -------
 
-Note that these examples may not for the latest version.
-
 Offline Rolling node reboot output
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 With the default options, the program shows one reboot group per line as
 a comma-separated list.
+::
 
-    $ hroller
+    $ hroller -L
     'Node Reboot Groups'
     node1.example.com,node3.example.com,node5.example.com
     node8.example.com,node6.example.com,node2.example.com