Rename the node storage commands
authorIustin Pop <iustin@google.com>
Tue, 27 Oct 2009 03:13:01 +0000 (12:13 +0900)
committerIustin Pop <iustin@google.com>
Wed, 28 Oct 2009 01:47:52 +0000 (10:47 +0900)
To reduce confusion, the following gnt-node commands are renamed:

- physical-volumes → list-storage
- modify-volume → modify-storage
- repair-volume → repair-storage

The NEWS file is update accordingly and it also gets emacs local
variables.

Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Michael Hanselmann <hansmi@google.com>

NEWS
man/gnt-node.sgml
scripts/gnt-node

diff --git a/NEWS b/NEWS
index 1d7fdb8..7404d10 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -43,8 +43,8 @@ Details
   - ``/2/nodes/[node_name]/storage/repair``
 
 - Added OpCodes to evacuate or migrate all instances on a node
-- Added new command to list physical volumes on nodes (``gnt-node
-  physical-volumes``) and to modify them (``gnt-node modify-volume``)
+- Added new command to list storage elements on nodes (``gnt-node
+  list-storage``) and modify them (``gnt-node modify-storage``)
 - Added new ssconf files with master candidate IP address
   (``ssconf_master_candidates_ips``), node primary IP address
   (``ssconf_node_primary_ips``) and node secondary IP address
@@ -57,7 +57,7 @@ Details
   --auto``)
 - Added ``gnt-instance recreate-disks`` to re-create (empty) disks
   after catastrophic data-loss
-- Added ``gnt-node repair-volume`` command to repair damanged LVM volume
+- Added ``gnt-node repair-storage`` command to repair damaged LVM volume
   groups
 - Added ``gnt-instance move`` command to move instances
 - Added ``gnt-cluster watcher`` command to control watcher
@@ -522,3 +522,7 @@ Version 1.2b2
 - Other small bugfixes
 
 .. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End:
index 836fc5d..6b8d9b1 100644 (file)
@@ -756,10 +756,10 @@ node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256  inst
     </refsect2>
 
     <refsect2>
-      <title>PHYSICAL-VOLUMES</title>
+      <title>LIST-STORAGE</title>
 
       <cmdsynopsis>
-        <command>physical-volumes</command>
+        <command>list-storage</command>
         <arg>--no-headers</arg>
         <arg>--human-readable</arg>
         <arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
@@ -770,7 +770,8 @@ node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256  inst
       </cmdsynopsis>
 
       <para>
-        Lists all physical volumes and their details from the node(s) provided.
+        Lists the available storage units and their details for the
+        given node(s).
       </para>
 
       <para>
@@ -855,7 +856,7 @@ node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256  inst
       <para>
         Example:
         <screen>
-# gnt-node physical-volumes node5.example.com
+# gnt-node list-storage node5.example.com
 Node              Name        Size Used   Free
 node5.example.com /dev/sda7 673.8G   0M 673.8G
 node5.example.com /dev/sdb1 698.6G 1.3G 697.4G
@@ -864,10 +865,10 @@ node5.example.com /dev/sdb1 698.6G 1.3G 697.4G
     </refsect2>
 
     <refsect2>
-      <title>MODIFY-VOLUME</title>
+      <title>MODIFY-STORAGE</title>
 
       <cmdsynopsis>
-        <command>modify-volume</command>
+        <command>modify-storage</command>
         <arg><option>--allocatable=yes|no</option></arg>
         <sbr>
         <arg><replaceable>node</replaceable></arg>
@@ -876,31 +877,32 @@ node5.example.com /dev/sdb1 698.6G 1.3G 697.4G
       </cmdsynopsis>
 
       <para>
-        Modifies storage volumes on a node. Only LVM physical volumes can be
-        modified at the moment. They have a storage type of <quote>lvm-pv</quote>.
+        Modifies storage volumes on a node. Only LVM physical volumes
+        can be modified at the moment. They have a storage type
+        of <quote>lvm-pv</quote>.
       </para>
 
       <para>
         Example:
         <screen>
-# gnt-node modify-volume --allocatable no node5.example.com lvm-pv /dev/sdb1
+# gnt-node modify-storage --allocatable no node5.example.com lvm-pv /dev/sdb1
         </screen>
       </para>
     </refsect2>
 
     <refsect2>
-      <title>REPAIR-VOLUME</title>
+      <title>REPAIR-STORAGE</title>
 
       <cmdsynopsis>
-        <command>repair-volume</command>
+        <command>repair-storage</command>
         <arg><replaceable>node</replaceable></arg>
         <arg><replaceable>storage-type</replaceable></arg>
         <arg><replaceable>volume-name</replaceable></arg>
       </cmdsynopsis>
 
       <para>
-        Repairs a storage volume on a node. Only LVM volume groups can be
-        repaired at this time. They have the storage type
+        Repairs a storage volume on a node. Only LVM volume groups can
+        be repaired at this time. They have the storage type
         <quote>lvm-vg</quote>.
       </para>
 
@@ -918,7 +920,7 @@ node5.example.com /dev/sdb1 698.6G 1.3G 697.4G
       <para>
         Example:
         <screen>
-# gnt-node repair-volume node5.example.com lvm-vg xenvg
+# gnt-node repair-storage node5.example.com lvm-vg xenvg
         </screen>
       </para>
     </refsect2>
index 564c125..68be359 100755 (executable)
@@ -458,7 +458,7 @@ def ListVolumes(opts, args):
   return 0
 
 
-def ListPhysicalVolumes(opts, args):
+def ListStorage(opts, args):
   """List physical volumes on node(s).
 
   @param opts: the command line options selected by the user
@@ -530,7 +530,7 @@ def ListPhysicalVolumes(opts, args):
   return 0
 
 
-def ModifyVolume(opts, args):
+def ModifyStorage(opts, args):
   """Modify storage volume on a node.
 
   @param opts: the command line options selected by the user
@@ -557,7 +557,7 @@ def ModifyVolume(opts, args):
     SubmitOpCode(op)
 
 
-def RepairVolume(opts, args):
+def RepairStorage(opts, args):
   """Repairs a storage volume on a node.
 
   @param opts: the command line options selected by the user
@@ -667,19 +667,19 @@ commands = {
     ListVolumes, [ArgNode()],
     [NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT],
     "[<node_name>...]", "List logical volumes on node(s)"),
-  'physical-volumes': (
-    ListPhysicalVolumes, ARGS_MANY_NODES,
+  'list-storage': (
+    ListStorage, ARGS_MANY_NODES,
     [NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, _STORAGE_TYPE_OPT],
     "[<node_name>...]", "List physical volumes on node(s)"),
-  'modify-volume': (
-    ModifyVolume,
+  'modify-storage': (
+    ModifyStorage,
     [ArgNode(min=1, max=1),
      ArgChoice(min=1, max=1, choices=_MODIFIABLE_STORAGE_TYPES),
      ArgFile(min=1, max=1)],
     [ALLOCATABLE_OPT],
     "<node_name> <storage_type> <name>", "Modify storage volume on a node"),
-  'repair-volume': (
-    RepairVolume,
+  'repair-storage': (
+    RepairStorage,
     [ArgNode(min=1, max=1),
      ArgChoice(min=1, max=1, choices=_REPAIRABLE_STORAGE_TYPES),
      ArgFile(min=1, max=1)],