document the ipreallocate command

[sahlberg/ctdb.git] / doc / ctdb.1.xml

diff --git a/doc/ctdb.1.xml b/doc/ctdb.1.xml
index a88e8ad9ccbae35086c401e99af6dadf51ba7432..b0661fd374fbe76d0a45bd97193fd020370c3c8c 100644 (file)
--- a/doc/ctdb.1.xml
+++ b/doc/ctdb.1.xml
@@ -539,6 +539,36 @@ CTDB version 1
       </para>
     </refsect2>
 
+    <refsect2><title>getreclock</title>
+      <para>
+       This command is used to show the filename of the reclock file that is used.
+      </para>
+
+      <para>
+       Example output:
+      </para>
+      <screen format="linespecific">
+Reclock file:/gpfs/.ctdb/shared
+      </screen>
+
+    </refsect2>
+
+    <refsect2><title>setreclock [filename]</title>
+      <para>
+       This command is used to modify, or clear, the file that is used as the reclock file at runtime. When this command is used, the reclock file checks are disabled. To re-enable the checks the administrator needs to activate the "VerifyRecoveryLock" tunable using "ctdb setvar".
+      </para>
+
+      <para>
+       If run with no parameter this will remove the reclock file completely. If run with a parameter the parameter specifies the new filename to use for the recovery lock.
+      </para>
+
+      <para>
+       This command only affects the runtime settings of a ctdb node and will be lost when ctdb is restarted. For persistent changes to the reclock file setting you must edit /etc/sysconfig/ctdb.
+      </para>
+    </refsect2>
+
+
+
     <refsect2><title>getdebug</title>
       <para>
         Get the current debug level for the node. the debug level controls what information is written to the log file.
@@ -661,6 +691,12 @@ CTDB version 1
       </para>
     </refsect2>
 
+    <refsect2><title>ipreallocate</title>
+      <para>
+        This command will force the recovery master to perform a full ip reallocation process and redistribute all ip addresses. This is useful to "reset" the allocations back to its default state if they have been changed using the "moveip" command. While a "recover" will also perform this reallocation, a recovery is much more hevyweight since it will also rebuild all the databases.
+      </para>
+    </refsect2>
+
     <refsect2><title>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</title>
       <para>
         This command will kill the specified TCP connection by issuing a
@@ -679,15 +715,10 @@ CTDB version 1
 
     <refsect2><title>reloadnodes</title>
       <para>
-      This command is used when adding new nodes to an existing cluster and
-      to reduce the disruption of this operation. This command should never
-      be used except when expanding an existing cluster.
-      This can only be used to expand a cluster. To remove a node from the
-      cluster you still need to shut down ctdb on all nodes, edit the nodes file
-      and restart ctdb.
+      This command is used when adding new nodes, or removing existing nodes from an existing cluster.
       </para>
       <para>
-      Procedure:
+      Procedure to add a node:
       </para>
       <para>
       1, To expand an existing cluster, first ensure with 'ctdb status' that
@@ -702,7 +733,7 @@ CTDB version 1
       3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
       </para>
       <para>
-      4, Run 'ctdb reloadnodes' to force all nodes to reaload the nodesfile.
+      4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
       </para>
       <para>
       5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
@@ -710,6 +741,29 @@ CTDB version 1
       <para>
       6, Install and configure the new node and bring it online.
       </para>
+      <para>
+      Procedure to remove a node:
+      </para>
+      <para>
+      1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
+      all nodes, except the node to be deleted, are up and running and that they are all healthy.
+      Do not try to remove a node from a cluster unless the cluster is completely healthy!
+      </para>
+      <para>
+      2, Shutdown and poerwoff the node to be removed.
+      </para>
+      <para>
+      3, On all other nodes, edit the /etc/ctdb/nodes file and comment out the node to be removed. Do not delete the line for that node, just comment it out by adding a '#' at the beginning of the line.
+      </para>
+      <para>
+      4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
+      </para>
+      <para>
+      5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
+      </para>
+      <para>
+      </para>
+      
     </refsect2>
 
     <refsect2><title>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</title>