Fix style inconsistencies in gnt-instance man page

[ganeti-local] / man / gnt-group.rst

diff --git a/man/gnt-group.rst b/man/gnt-group.rst
index a260e65..12b4c84 100644 (file)
--- a/man/gnt-group.rst
+++ b/man/gnt-group.rst
@@ -23,25 +23,23 @@ COMMANDS
 ADD
 ~~~
 
 ADD
 ~~~
 

-| **add**
-| [--node-parameters=*NDPARAMS*]
-| [--alloc-policy=*POLICY*]
-| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
-| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
-| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
-| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
-| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
-| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
-| [--specs-disk-templates *template* [,*template*...]]
-| [--disk-state *diskstate*]
-| [--hypervisor-state *hvstate*]
+| **add** [\--submit]
+| [\--node-parameters=*NDPARAMS*]
+| [\--alloc-policy=*POLICY*]
+| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
+| [\--ipolicy-bounds-specs *bound_ispecs*]
+| [\--ipolicy-disk-templates *template* [,*template*...]]
+| [\--ipolicy-spindle-ratio *ratio*]
+| [\--ipolicy-vcpu-ratio *ratio*]
+| [\--disk-state *diskstate*]
+| [\--hypervisor-state *hvstate*]

 | {*group*}
 
 Creates a new group with the given name. The node group will be
 initially empty; to add nodes to it, use ``gnt-group assign-nodes``.
 
 The ``--node-parameters`` option allows you to set default node
 | {*group*}
 
 Creates a new group with the given name. The node group will be
 initially empty; to add nodes to it, use ``gnt-group assign-nodes``.
 
 The ``--node-parameters`` option allows you to set default node

-parameters for nodes in the group. Please see **ganeti**(7) for more
+parameters for nodes in the group. Please see **ganeti**\(7) for more

 information about supported key=value pairs and their corresponding
 options.
 
 information about supported key=value pairs and their corresponding
 options.
 

@@ -64,17 +62,20 @@ preferred
 
 The ``-D (--disk-parameters)`` option allows you to set the disk
 parameters for the node group; please see the section about
 
 The ``-D (--disk-parameters)`` option allows you to set the disk
 parameters for the node group; please see the section about

-**gnt-cluster add** in **gnt-cluster**(8) for more information about
+**gnt-cluster add** in **gnt-cluster**\(8) for more information about

 disk parameters
 
 disk parameters
 

-The ``--specs-...`` options specify instance policies on the node group,
-and are documented in the **gnt-cluster**(8) man page.
+The ``--ipolicy-...`` options specify instance policies on the node
+group, and are documented in the **gnt-cluster**\(8) man page.
+
+See **ganeti**\(7) for a description of ``--submit`` and other common
+options.

 
 ASSIGN-NODES
 ~~~~~~~~~~~~
 
 | **assign-nodes**
 
 ASSIGN-NODES
 ~~~~~~~~~~~~
 
 | **assign-nodes**

-| [--force]
+| [\--force] [\--submit]

 | {*group*} {*node*...}
 
 Assigns one or more nodes to the specified group, moving them from their
 | {*group*} {*node*...}
 
 Assigns one or more nodes to the specified group, moving them from their

@@ -86,49 +87,56 @@ instance is an instance with a mirrored disk template, e.g. DRBD, that
 has the primary and secondary nodes in different node groups). You can
 force the operation with ``--force``.
 
 has the primary and secondary nodes in different node groups). You can
 force the operation with ``--force``.
 

+See **ganeti**\(7) for a description of ``--submit`` and other common
+options.
+

 MODIFY
 ~~~~~~
 
 MODIFY
 ~~~~~~
 

-| **modify**
-| [--node-parameters=*NDPARAMS*]
-| [--alloc-policy=*POLICY*]
-| [--hypervisor-state *hvstate*]
-| [{-D|--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
-| [--disk-state *diskstate*]
-| [--specs-cpu-count *spec-param*=*value* [,*spec-param*=*value*...]]
-| [--specs-disk-count *spec-param*=*value* [,*spec-param*=*value*...]]
-| [--specs-disk-size *spec-param*=*value* [,*spec-param*=*value*...]]
-| [--specs-mem-size *spec-param*=*value* [,*spec-param*=*value*...]]
-| [--specs-nic-count *spec-param*=*value* [,*spec-param*=*value*...]]
-| [--specs-disk-templates *template* [,*template*...]]
+| **modify** [\--submit]
+| [\--node-parameters=*NDPARAMS*]
+| [\--alloc-policy=*POLICY*]
+| [\--hypervisor-state *hvstate*]
+| [{-D|\--disk-parameters} *disk-template*:*disk-param*=*value*[,*disk-param*=*value*...]]
+| [\--disk-state *diskstate*]
+| [\--ipolicy-bounds-specs *bound_ispecs*]
+| [\--ipolicy-disk-templates *template* [,*template*...]]
+| [\--ipolicy-spindle-ratio *ratio*]
+| [\--ipolicy-vcpu-ratio *ratio*]

 | {*group*}
 
 Modifies some parameters from the node group.
 
 The ``--node-parameters`` and ``--alloc-policy`` options are documented
 in the **add** command above. ``--hypervisor-state`` as well as
 | {*group*}
 
 Modifies some parameters from the node group.
 
 The ``--node-parameters`` and ``--alloc-policy`` options are documented
 in the **add** command above. ``--hypervisor-state`` as well as

-``--disk-state`` are documented in detail in **ganeti**(7).
+``--disk-state`` are documented in detail in **ganeti**\(7).

 
 The ``--node-parameters``, ``--alloc-policy``, ``-D
 (--disk-parameters)`` options are documented in the **add** command
 above.
 
 
 The ``--node-parameters``, ``--alloc-policy``, ``-D
 (--disk-parameters)`` options are documented in the **add** command
 above.
 

-The ``--specs-...`` options specify instance policies on the node group,
-and are documented in the **gnt-cluster**(8) man page.
+The ``--ipolicy-...`` options specify instance policies on the node
+group, and are documented in the **gnt-cluster**\(8) man page.
+
+See **ganeti**\(7) for a description of ``--submit`` and other common
+options.

 
 REMOVE
 ~~~~~~
 
 
 REMOVE
 ~~~~~~
 

-| **remove** {*group*}
+| **remove** [\--submit] {*group*}

 
 Deletes the indicated node group, which must be empty. There must always be at
 least one group, so the last group cannot be removed.
 
 
 Deletes the indicated node group, which must be empty. There must always be at
 least one group, so the last group cannot be removed.
 

+See **ganeti**\(7) for a description of ``--submit`` and other common
+options.
+

 LIST
 ~~~~
 
 LIST
 ~~~~
 

-| **list** [--no-headers] [--separator=*SEPARATOR*] [-v]
-| [-o *[+]FIELD,...*] [--filter] [group...]
+| **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
+| [-o *[+]FIELD,...*] [\--filter] [group...]

 
 Lists all existing node groups in the cluster.
 
 
 Lists all existing node groups in the cluster.
 

@@ -138,7 +146,7 @@ used between the output fields. Both these options are to help
 scripting.
 
 The ``-v`` option activates verbose mode, which changes the display of
 scripting.
 
 The ``-v`` option activates verbose mode, which changes the display of

-special field states (see **ganeti(7)**).
+special field states (see **ganeti**\(7)).

 
 The ``-o`` option takes a comma-separated list of output fields.
 If the value of the option starts with the character ``+``, the new
 
 The ``-o`` option takes a comma-separated list of output fields.
 If the value of the option starts with the character ``+``, the new

@@ -151,7 +159,7 @@ The available fields and their meaning are:
 @QUERY_FIELDS_GROUP@
 
 If exactly one argument is given and it appears to be a query filter
 @QUERY_FIELDS_GROUP@
 
 If exactly one argument is given and it appears to be a query filter

-(see **ganeti(7)**), the query result is filtered accordingly. For
+(see **ganeti**\(7)), the query result is filtered accordingly. For

 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
 (``-F``) option forces the argument to be treated as a filter.
 
 ambiguous cases (e.g. a single field name as a filter) the ``--filter``
 (``-F``) option forces the argument to be treated as a filter.
 

@@ -168,15 +176,18 @@ List available fields for node groups.
 RENAME
 ~~~~~~
 
 RENAME
 ~~~~~~
 

-| **rename** {*oldname*} {*newname*}
+| **rename** [\--submit] {*oldname*} {*newname*}

 
 Renames a given group from *oldname* to *newname*.
 
 
 Renames a given group from *oldname* to *newname*.
 

+See **ganeti**\(7) for a description of ``--submit`` and other common
+options.
+

 
 EVACUATE
 ~~~~~~~~
 
 
 EVACUATE
 ~~~~~~~~
 

-**evacuate** [--iallocator *NAME*] [--to *GROUP*...] {*group*}
+**evacuate** [\--submit] [\--iallocator *NAME*] [\--to *GROUP*...] {*group*}

 
 This command will move all instances out of the given node group.
 Instances are placed in a new group by an iallocator, either given on
 
 This command will move all instances out of the given node group.
 Instances are placed in a new group by an iallocator, either given on

@@ -185,18 +196,21 @@ the command line or as a cluster default.
 If no specific destination groups are specified using ``--to``, all
 groups except the evacuated group are considered.
 
 If no specific destination groups are specified using ``--to``, all
 groups except the evacuated group are considered.
 

+See **ganeti**\(7) for a description of ``--submit`` and other common
+options.
+

 Example::
 
     # gnt-group evacuate -I hail --to rack4 rack1
 
 
 Example::
 
     # gnt-group evacuate -I hail --to rack4 rack1
 
 

-TAGS
+Tags

 ~~~~
 
 ADD-TAGS
 ^^^^^^^^
 
 ~~~~
 
 ADD-TAGS
 ^^^^^^^^
 

-**add-tags** [--from *file*] {*groupname*} {*tag*...}
+**add-tags** [\--from *file*] {*groupname*} {*tag*...}

 
 Add tags to the given node group. If any of the tags contains invalid
 characters, the entire operation will abort.
 
 Add tags to the given node group. If any of the tags contains invalid
 characters, the entire operation will abort.

@@ -217,7 +231,7 @@ List the tags of the given node group.
 REMOVE-TAGS
 ^^^^^^^^^^^
 
 REMOVE-TAGS
 ^^^^^^^^^^^
 

-**remove-tags** [--from *file*] {*groupname*} {*tag*...}
+**remove-tags** [\--from *file*] {*groupname*} {*tag*...}

 
 Remove tags from the given node group. If any of the tags are not
 existing on the node, the entire operation will abort.
 
 Remove tags from the given node group. If any of the tags are not
 existing on the node, the entire operation will abort.

@@ -228,6 +242,27 @@ this case, there is not need to pass tags on the command line (if you
 do, tags from both sources will be removed). A file name of ``-`` will
 be interpreted as stdin.
 
 do, tags from both sources will be removed). A file name of ``-`` will
 be interpreted as stdin.
 

+INFO
+~~~~
+
+**info** [*group*...]
+
+Shows config information for all (or given) groups.
+
+SHOW-ISPECS-CMD
+~~~~~~~~~~~~~~~
+
+**show-ispecs-cmd** [\--include-defaults] [*group*...]
+
+Shows the command line that can be used to recreate the given groups (or
+all groups, if none is given) with the same options relative to specs in
+the instance policies.
+
+If ``--include-defaults`` is specified, include also the default values
+(i.e. the cluster-level settings), and not only the configuration items
+that a group overrides.
+
+

 .. vim: set textwidth=72 :
 .. Local Variables:
 .. mode: rst
 .. vim: set textwidth=72 :
 .. Local Variables:
 .. mode: rst