documentation - Admin-Guide Updates

Change-Id: I6e053b6a5f099fb7b1c228668949463c795b4fc7
Signed-off-by: Amar Tumballi <amarts@redhat.com>
Reviewed-on: http://review.gluster.com/3496
Tested-by: Gluster Build System <jenkins@build.gluster.com>
Reviewed-by: Vijay Bellur <vijay@gluster.com>

1 files changed, 35 insertions, 33 deletions

diff --git a/doc/admin-guide/en-US/admin_commandref.xml b/doc/admin-guide/en-US/admin_commandref.xml
index df4c78f4869..05196b77326 100644
--- a/doc/admin-guide/en-US/admin_commandref.xml
+++ b/doc/admin-guide/en-US/admin_commandref.xml
@@ -2,8 +2,7 @@
 <!-- This document was created with Syntext Serna Free. --><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "docbookV4.5/docbookx.dtd" []>
 <chapter id="chap-Administration_Guide-Com_Ref">
   <title>Command Reference </title>
-  <para>This section describes the available  commands and includes the
-following section:
+  <para>This section describes the available  commands and includes thefollowing section:
 </para>
   <itemizedlist>
     <listitem>
@@ -36,10 +35,8 @@ gluster [COMMANDS] [OPTIONS]
 </para>
     <para><emphasis role="bold">DESCRIPTION</emphasis>
 </para>
-    <para>The Gluster Console Manager is a command line utility for elastic volume management. You can run
-the gluster command on any export server. The command enables administrators to perform cloud
-operations such as creating, expanding, shrinking, rebalancing, and migrating volumes without
-needing to schedule server downtime.
+    <para>The Gluster Console Manager is a command line utility for elastic volume management. 'gluster' command enables administrators to perform cloud
+operations such as creating, expanding, shrinking, rebalancing, and migrating volumes without needing to schedule server downtime.
 </para>
     <para><emphasis role="bold">COMMANDS</emphasis>
 </para>
@@ -66,7 +63,8 @@ needing to schedule server downtime.
             </row>
             <row>
               <entry>volume create NEW-VOLNAME [stripe COUNT] [replica COUNT] [transport tcp | rdma | tcp,rdma] NEW-BRICK ...</entry>
-              <entry namest="cgen1" nameend="c1">Creates a new volume of the specified type using the specified bricks and transport type (the default transport type is tcp).</entry>
+              <entry namest="cgen1" nameend="c1">Creates a new volume of the specified type using the specified bricks and transport type (the default transport type is tcp).
+              NOTE: with 3.3.0 release, transport type 'rdma' and 'tcp,rdma' are not fully supported.</entry>
             </row>
             <row>
               <entry>volume delete VOLNAME</entry>
@@ -81,10 +79,6 @@ needing to schedule server downtime.
               <entry namest="cgen1" nameend="c1">Stops the specified volume. </entry>
             </row>
             <row>
-              <entry>volume rename VOLNAME NEW-VOLNAME </entry>
-              <entry namest="cgen1" nameend="c1">Renames the specified volume.</entry>
-            </row>
-            <row>
               <entry>volume help </entry>
               <entry namest="cgen1" nameend="c1">Displays help for the volume command.</entry>
             </row>
@@ -94,16 +88,16 @@ needing to schedule server downtime.
               </entry>
             </row>
             <row>
-              <entry>volume add-brick VOLNAME NEW-BRICK ... </entry>
-              <entry namest="cgen1" nameend="c1">Adds the specified brick to the specified volume.</entry>
+              <entry>volume add-brick VOLNAME [replica N] [stripe N] NEW-BRICK1 ... </entry>
+              <entry namest="cgen1" nameend="c1">Adds the specified brick(s) to the given VOLUME. Using add-brick, users can increase the replica/stripe count of the volume, or increase the volume capacity by adding the brick(s) without changing volume type. </entry>
             </row>
             <row>
-              <entry>volume replace-brick VOLNAME (BRICK NEW-BRICK) start | pause | abort | status </entry>
-              <entry namest="cgen1" nameend="c1">Replaces the specified brick.</entry>
+              <entry>volume replace-brick VOLNAME (BRICK NEW-BRICK) [start | start force | abort | status | commit | commit force] </entry>
+              <entry namest="cgen1" nameend="c1">Used to replace BRICK with NEW-BRICK in a given VOLUME. After replace-brick is complete, the changes to get reflected in volume information, replace-brick 'commit' command is neccessary.</entry>
             </row>
             <row>
-              <entry>volume remove-brick VOLNAME [(replica COUNT)|(stripe COUNT)] BRICK ... </entry>
-              <entry namest="cgen1" nameend="c1">Removes the specified brick from the specified volume.</entry>
+              <entry>volume remove-brick VOLNAME [replica N] BRICK1 ... [start | stop | status | commit | force ] </entry>
+              <entry namest="cgen1" nameend="c1">Removes the specified brick(s) from the specified volume. 'remove-brick' command can be used to reduce the replica count of the volume when 'replica N' option is given. To ensure data migration from the removed brick to existing bricks, give 'start' sub-command at the end of the command. After the 'status' command says remove-brick operation is complete, user can 'commit' the changes to volume file. Using 'remove-brick' without 'start' option works similar to 'force' command, which makes the changes to volume configuration without migrating the data.</entry>
             </row>
             <row>
               <entry namest="c0" nameend="c1" align="left">
@@ -112,7 +106,7 @@ needing to schedule server downtime.
             </row>
             <row>
               <entry>volume rebalance VOLNAME start</entry>
-              <entry namest="cgen1" nameend="c1">Starts rebalancing the specified volume.</entry>
+              <entry namest="cgen1" nameend="c1">Starts rebalancing of the data on specified volume.</entry>
             </row>
             <row>
               <entry>volume rebalance VOLNAME stop </entry>
@@ -128,16 +122,31 @@ needing to schedule server downtime.
               </entry>
             </row>
             <row>
-              <entry>volume log filename VOLNAME [BRICK] DIRECTORY </entry>
-              <entry namest="cgen1" nameend="c1">Sets the log directory for the corresponding volume/brick. </entry>
-            </row>
-            <row>
               <entry>volume log rotate VOLNAME [BRICK] </entry>
               <entry namest="cgen1" nameend="c1">Rotates the log file for corresponding volume/brick.</entry>
             </row>
+
+            <row>
+              <entry namest="c0" nameend="c1" align="left">
+                <emphasis role="bold">Debugging</emphasis>
+              </entry>
+            </row>
             <row>
-              <entry>volume log locate VOLNAME [BRICK] </entry>
-              <entry namest="cgen1" nameend="c1">Locates the log file for corresponding volume/brick. </entry>
+              <entry>volume top VOLNAME {[open|read|write|opendir|readdir [nfs]] |[read-perf|write-perf [nfs|{bs COUNT count COUNT}]]|[clear [nfs]]} [BRICK] [list-cnt COUNT]</entry>
+              <entry namest="cgen1" nameend="c1">Shows the operation details on the volume depending on the arguments given. </entry>
+            </row>
+
+            <row>
+              <entry>volume profile VOLNAME {start|info|stop} [nfs]</entry>
+              <entry namest="cgen1" nameend="c1">Shows the file operation details on each bricks of the volume.</entry>
+            </row>
+            <row>
+              <entry>volume status [all | VOLNAME] [nfs|shd|BRICK] [detail|clients|mem|inode|fd|callpool]</entry>
+              <entry namest="cgen1" nameend="c1">Show details of activity, internal data of the processes (nfs/shd/BRICK) corresponding to one of the next argument given. If now argument is given, this command outputs bare minimum details of the current status (include PID of brick process etc) of volume's bricks.</entry>
+            </row>
+            <row>
+              <entry>statedump VOLNAME [nfs] [all|mem|iobuf|callpool|priv|fd|inode|history]</entry>
+              <entry namest="cgen1" nameend="c1">Command is used to take the statedump of the process, which is used captures most of the internal details. </entry>
             </row>
             <row>
               <entry namest="c0" nameend="c1" align="left">
@@ -182,7 +191,6 @@ needing to schedule server downtime.
             </row>
             <row>
               <entry morerows="10">volume geo-replication MASTER SLAVE config [options]</entry>
-              <entry/>
               <entry>Configure geo-replication options between the hosts specified by MASTER and SLAVE. </entry>
             </row>
             <row>
@@ -226,7 +234,6 @@ needing to schedule server downtime.
               <entry>The number of simultaneous files/directories that can be synchronized.</entry>
             </row>
             <row>
-              <entry/>
               <entry>ignore-deletes</entry>
               <entry>If this option is set to 1, a file deleted on master will not trigger a delete operation on the slave. Hence, the slave will remain as a superset of the master and can be used to recover the master in case of crash and/or accidental delete.</entry>
             </row>
@@ -237,7 +244,6 @@ needing to schedule server downtime.
             </row>
             <row>
               <entry>help</entry>
-              <entry/>
               <entry>Display the command options.</entry>
             </row>
             <row>
@@ -251,10 +257,8 @@ needing to schedule server downtime.
     <para><emphasis role="bold">FILES</emphasis>
 
 </para>
-    <para>/etc/glusterd/*
+    <para>/var/lib/glusterd/*
 </para>
-    <para><emphasis role="bold">SEE ALSO </emphasis></para>
-    <para>fusermount(1), mount.glusterfs(8), glusterfs-volgen(8), glusterfs(8), glusterd(8)</para>
   </section>
   <section>
     <title>glusterd Daemon </title>
@@ -326,9 +330,7 @@ needing to schedule server downtime.
     <para><emphasis role="bold">FILES</emphasis>
 
 </para>
-    <para>/etc/glusterd/*
+    <para>/var/lib/glusterd/*
 </para>
-    <para><emphasis role="bold">SEE ALSO </emphasis></para>
-    <para>fusermount(1), mount.glusterfs(8), glusterfs-volgen(8), glusterfs(8), gluster(8)</para>
   </section>
 </chapter>