htools: Make it possible to load an IAlloc request

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

diff --git a/man/gnt-node.rst b/man/gnt-node.rst
index 6160ae7..b8cc2af 100644 (file)
--- a/man/gnt-node.rst
+++ b/man/gnt-node.rst
@@ -23,9 +23,12 @@ COMMANDS
 ADD
 ~~~
 
 ADD
 ~~~
 

-| **add** [--readd] [-s *secondary\_ip*] [-g *nodegroup*]
-| [--master-capable=``yes|no``] [--vm-capable=``yes|no``]
-| [--node-parameters *ndparams*]
+| **add** [\--readd] [{-s|\--secondary-ip} *secondary\_ip*]
+| [{-g|\--node-group} *nodegroup*]
+| [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``]
+| [\--node-parameters *ndparams*]
+| [\--disk-state *diskstate*]
+| [\--hypervisor-state *hvstate*]

 | {*nodename*}
 
 Adds the given node to the cluster.
 | {*nodename*}
 
 Adds the given node to the cluster.

@@ -39,9 +42,9 @@ Note that the command is potentially destructive, as it will
 forcibly join the specified host the cluster, not paying attention
 to its current status (it could be already in a cluster, etc.)
 
 forcibly join the specified host the cluster, not paying attention
 to its current status (it could be already in a cluster, etc.)
 

-The ``-s`` is used in dual-home clusters and specifies the new node's
-IP in the secondary network. See the discussion in **gnt-cluster**(8)
-for more information.
+The ``-s (--secondary-ip)`` is used in dual-home clusters and
+specifies the new node's IP in the secondary network. See the
+discussion in **gnt-cluster**(8) for more information.

 
 In case you're readding a node after hardware failure, you can use
 the ``--readd`` parameter. In this case, you don't need to pass the
 
 In case you're readding a node after hardware failure, you can use
 the ``--readd`` parameter. In this case, you don't need to pass the

@@ -53,13 +56,20 @@ The ``--force-join`` option is to proceed with adding a node even if it already
 appears to belong to another cluster. This is used during cluster merging, for
 example.
 
 appears to belong to another cluster. This is used during cluster merging, for
 example.
 

-The ``-g`` is used to add the new node into a specific node group,
-specified by UUID or name. If only one node group exists you can
-skip this option, otherwise it's mandatory.
+The ``-g (--node-group)`` option is used to add the new node into a
+specific node group, specified by UUID or name. If only one node group
+exists you can skip this option, otherwise it's mandatory.

 
 

-The ``vm_capable``, ``master_capable`` and ``ndparams`` options are
-described in **ganeti**(7), and are used to set the properties of the
-new node.
+The ``vm_capable``, ``master_capable``, ``ndparams``, ``diskstate`` and
+``hvstate`` options are described in **ganeti**(7), and are used to set
+the properties of the new node.
+
+The command performs some operations that change the state of the master
+and the new node, like copying certificates and starting the node daemon
+on the new node, or updating ``/etc/hosts`` on the master node.  If the
+command fails at a later stage, it doesn't undo such changes.  This
+should not be a problem, as a successful run of ``gnt-node add`` will
+bring everything back in sync.

 
 Example::
 
 
 Example::
 

@@ -71,7 +81,7 @@ Example::
 ADD-TAGS
 ~~~~~~~~
 
 ADD-TAGS
 ~~~~~~~~
 

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

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

@@ -85,22 +95,25 @@ interpreted as stdin.
 EVACUATE
 ~~~~~~~~
 
 EVACUATE
 ~~~~~~~~
 

-**evacuate** [-f] [--early-release] [--iallocator *NAME* \|
---new-secondary *destination\_node*] {*node*...}
+**evacuate** [-f] [\--early-release] [\--iallocator *NAME* \|
+\--new-secondary *destination\_node*]
+[\--primary-only \| \--secondary-only] [\--early-release] {*node*}

 
 

-This command will move all secondary instances away from the given
-node(s). It works only for instances having a drbd disk template.
+This command will move instances away from the given node. If
+``--primary-only`` is given, only primary instances are evacuated, with
+``--secondary-only`` only secondaries. If neither is given, all
+instances are evacuated. It works only for instances having a drbd disk
+template.

 
 The new location for the instances can be specified in two ways:
 
 
 The new location for the instances can be specified in two ways:
 

-- as a single node for all instances, via the ``--new-secondary``
+- as a single node for all instances, via the ``-n (--new-secondary)``

   option
 
   option
 

-- or via the ``--iallocator`` option, giving a script name as
+- or via the ``-I (--iallocator)`` option, giving a script name as

   parameter, so each instance will be in turn placed on the (per the
   script) optimal node
 
   parameter, so each instance will be in turn placed on the (per the
   script) optimal node
 

-

 The ``--early-release`` changes the code so that the old storage on
 node being evacuated is removed early (before the resync is
 completed) and the internal Ganeti locks are also released for both
 The ``--early-release`` changes the code so that the old storage on
 node being evacuated is removed early (before the resync is
 completed) and the internal Ganeti locks are also released for both

@@ -111,15 +124,28 @@ old storage is already broken) or when the storage on the primary
 node is known to be fine (thus we won't need the old storage for
 potential recovery).
 
 node is known to be fine (thus we won't need the old storage for
 potential recovery).
 

+Note that this command is equivalent to using per-instance commands for
+each affected instance individually:
+
+- ``--primary-only`` is equivalent to ``gnt-instance
+  failover/migration`` for non-DRBD instances, but for DRBD instances
+  it's different, and usually is a slow process (it will change the
+  primary to another node while keeping the secondary, this requiring
+  data copies, whereas failover/migrate will only toggle the
+  primary/secondary roles, a fast process)
+- ``--secondary-only`` is equivalent to ``gnt-instance replace-disks``
+  in the secondary node change mode (only valid for DRBD instances)
+- when neither of the above is done a combination of the two cases is run
+

 Example::
 
 Example::
 

-    # gnt-node evacuate -I dumb node3.example.com
+    # gnt-node evacuate -I hail node3.example.com

 
 
 FAILOVER
 ~~~~~~~~
 
 
 
 FAILOVER
 ~~~~~~~~
 

-**failover** [-f] [--ignore-consistency] {*node*}
+**failover** [-f] [\--ignore-consistency] {*node*}

 
 This command will fail over all instances having the given node as
 primary to their secondary nodes. This works only for instances having
 
 This command will fail over all instances having the given node as
 primary to their secondary nodes. This works only for instances having

@@ -148,8 +174,9 @@ LIST
 ~~~~
 
 | **list**
 ~~~~
 
 | **list**

-| [--no-headers] [--separator=*SEPARATOR*]
-| [--units=*UNITS*] [-v] [-o *[+]FIELD,...*]
+| [\--no-headers] [\--separator=*SEPARATOR*]
+| [\--units=*UNITS*] [-v] [{-o|\--output} *[+]FIELD,...*]
+| [\--filter]

 | [node...]
 
 Lists the nodes in the cluster.
 | [node...]
 
 Lists the nodes in the cluster.

@@ -172,29 +199,34 @@ give inconsistent results for the free disk/memory.
 The ``-v`` option activates verbose mode, which changes the display of
 special field states (see **ganeti(7)**).
 
 The ``-v`` option activates verbose mode, which changes the display of
 special field states (see **ganeti(7)**).
 

-The ``-o`` option takes a comma-separated list of output fields.
-The available fields and their meaning are:
+The ``-o (--output)`` option takes a comma-separated list of output
+fields. The available fields and their meaning are:

 
 @QUERY_FIELDS_NODE@
 
 If the value of the option starts with the character ``+``, the new
 
 @QUERY_FIELDS_NODE@
 
 If the value of the option starts with the character ``+``, the new

-fields will be added to the default list. This allows to quickly
+fields will be added to the default list. This allows one to quickly

 see the default list plus a few other fields, instead of retyping
 the entire list of fields.
 
 see the default list plus a few other fields, instead of retyping
 the entire list of fields.
 

-Note that some of this fields are known from the configuration of
-the cluster (e.g. name, pinst, sinst, pip, sip and thus the master
-does not need to contact the node for this data (making the listing
-fast if only fields from this set are selected), whereas the other
-fields are "live" fields and we need to make a query to the cluster
-nodes.
-
-Depending on the virtualization type and implementation details,
-the mtotal, mnode and mfree may have slighly varying meanings. For
-example, some solutions share the node memory with the pool of
-memory used for instances (KVM), whereas others have separate
+Note that some of these fields are known from the configuration of the
+cluster (e.g. ``name``, ``pinst``, ``sinst``, ``pip``, ``sip``) and thus
+the master does not need to contact the node for this data (making the
+listing fast if only fields from this set are selected), whereas the
+other fields are "live" fields and require a query to the cluster nodes.
+
+Depending on the virtualization type and implementation details, the
+``mtotal``, ``mnode`` and ``mfree`` fields may have slighly varying
+meanings. For example, some solutions share the node memory with the
+pool of memory used for instances (KVM), whereas others have separate

 memory for the node and for the instances (Xen).
 
 memory for the node and for the instances (Xen).
 

+If exactly one argument is given and it appears to be a query filter
+(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 (e.g.
+``gnt-node list -F master_candidate``).
+

 If no node names are given, then all nodes are queried. Otherwise,
 only the given nodes will be listed.
 
 If no node names are given, then all nodes are queried. Otherwise,
 only the given nodes will be listed.
 

@@ -217,16 +249,19 @@ List the tags of the given node.
 MIGRATE
 ~~~~~~~
 
 MIGRATE
 ~~~~~~~
 

-**migrate** [-f] [--non-live] [--migration-mode=live\|non-live]
-{*node*}
+**migrate** [-f] [\--non-live] [\--migration-mode=live\|non-live]
+[\--ignore-ipolicy] {*node*}

 
 This command will migrate all instances having the given node as
 primary to their secondary nodes. This works only for instances
 having a drbd disk template.
 
 As for the **gnt-instance migrate** command, the options
 
 This command will migrate all instances having the given node as
 primary to their secondary nodes. This works only for instances
 having a drbd disk template.
 
 As for the **gnt-instance migrate** command, the options

-``--no-live`` and ``--migration-mode`` can be given to influence
-the migration type.
+``--no-live``, ``--migration-mode`` and ``--no-runtime-changes``
+can be given to influence the migration type.
+
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.

 
 Example::
 
 
 Example::
 

@@ -236,12 +271,15 @@ Example::
 MODIFY
 ~~~~~~
 
 MODIFY
 ~~~~~~
 

-| **modify** [-f] [--submit]
-| [--master-candidate=``yes|no``] [--drained=``yes|no``] [--offline=``yes|no``]
-| [--master-capable=``yes|no``] [--vm-capable=``yes|no``] [--auto-promote]
-| [-s *secondary_ip*]
-| [--node-parameters *ndparams*]
-| [--node-powered=``yes|no``]
+| **modify** [-f] [\--submit]
+| [{-C|\--master-candidate} ``yes|no``]
+| [{-D|\--drained} ``yes|no``] [{-O|\--offline} ``yes|no``]
+| [\--master-capable=``yes|no``] [\--vm-capable=``yes|no``] [\--auto-promote]
+| [{-s|\--secondary-ip} *secondary_ip*]
+| [\--node-parameters *ndparams*]
+| [\--node-powered=``yes|no``]
+| [\--hypervisor-state *hvstate*]
+| [\--disk-state *diskstate*]

 | {*node*}
 
 This command changes the role of the node. Each options takes
 | {*node*}
 
 This command changes the role of the node. Each options takes

@@ -249,8 +287,8 @@ either a literal yes or no, and only one option should be given as
 yes. The meaning of the roles and flags are described in the
 manpage **ganeti**(7).
 
 yes. The meaning of the roles and flags are described in the
 manpage **ganeti**(7).
 

-``--node-powered`` can be used to modify state-of-record if it doesn't reflect
-the reality anymore.
+The option ``--node-powered`` can be used to modify state-of-record if
+it doesn't reflect the reality anymore.

 
 In case a node is demoted from the master candidate role, the
 operation will be refused unless you pass the ``--auto-promote``
 
 In case a node is demoted from the master candidate role, the
 operation will be refused unless you pass the ``--auto-promote``

@@ -266,9 +304,9 @@ candidate role if is in that role)::
 
     # gnt-node modify --offline=yes node1.example.com
 
 
     # gnt-node modify --offline=yes node1.example.com
 

-The ``-s`` can be used to change the node's secondary ip. No drbd
-instances can be running on the node, while this operation is
-taking place.
+The ``-s (--secondary-ip)`` option can be used to change the node's
+secondary ip. No drbd instances can be running on the node, while this
+operation is taking place.

 
 Example (setting the node back to online and master candidate)::
 
 
 Example (setting the node back to online and master candidate)::
 

@@ -291,7 +329,7 @@ Example::
 REMOVE-TAGS
 ~~~~~~~~~~~
 
 REMOVE-TAGS
 ~~~~~~~~~~~
 

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

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

@@ -305,8 +343,8 @@ be interpreted as stdin.
 VOLUMES
 ~~~~~~~
 
 VOLUMES
 ~~~~~~~
 

-| **volumes** [--no-headers] [--human-readable]
-| [--separator=*SEPARATOR*] [--output=*FIELDS*]
+| **volumes** [\--no-headers] [\--human-readable]
+| [\--separator=*SEPARATOR*] [{-o|\--output} *FIELDS*]

 | [*node*...]
 
 Lists all logical volumes and their physical disks from the node(s)
 | [*node*...]
 
 Lists all logical volumes and their physical disks from the node(s)

@@ -324,8 +362,8 @@ option is given, then the values are shown in mebibytes to allow
 parsing by scripts. In both cases, the ``--units`` option can be
 used to enforce a given output unit.
 
 parsing by scripts. In both cases, the ``--units`` option can be
 used to enforce a given output unit.
 

-The ``-o`` option takes a comma-separated list of output fields.
-The available fields and their meaning are:
+The ``-o (--output)`` option takes a comma-separated list of output
+fields. The available fields and their meaning are:

 
 node
     the node name on which the volume exists
 
 node
     the node name on which the volume exists

@@ -358,9 +396,9 @@ Example::
 LIST-STORAGE
 ~~~~~~~~~~~~
 
 LIST-STORAGE
 ~~~~~~~~~~~~
 

-| **list-storage** [--no-headers] [--human-readable]
-| [--separator=*SEPARATOR*] [--storage-type=*STORAGE\_TYPE*]
-| [--output=*FIELDS*]
+| **list-storage** [\--no-headers] [\--human-readable]
+| [\--separator=*SEPARATOR*] [\--storage-type=*STORAGE\_TYPE*]
+| [{-o|\--output} *FIELDS*]

 | [*node*...]
 
 Lists the available storage units and their details for the given
 | [*node*...]
 
 Lists the available storage units and their details for the given

@@ -381,8 +419,8 @@ used to enforce a given output unit.
 The ``--storage-type`` option can be used to choose a storage unit
 type. Possible choices are lvm-pv, lvm-vg or file.
 
 The ``--storage-type`` option can be used to choose a storage unit
 type. Possible choices are lvm-pv, lvm-vg or file.
 

-The ``-o`` option takes a comma-separated list of output fields.
-The available fields and their meaning are:
+The ``-o (--output)`` option takes a comma-separated list of output
+fields. The available fields and their meaning are:

 
 node
     the node name on which the volume exists
 
 node
     the node name on which the volume exists

@@ -443,14 +481,14 @@ Example::
 REPAIR-STORAGE
 ~~~~~~~~~~~~~~
 
 REPAIR-STORAGE
 ~~~~~~~~~~~~~~
 

-**repair-storage** [--ignore-consistency] {*node*} {*storage-type*}
+**repair-storage** [\--ignore-consistency] {*node*} {*storage-type*}

 {*volume-name*}
 
 Repairs a storage volume on a node. Only LVM volume groups can be
 repaired at this time. They have the storage type "lvm-vg".
 
 {*volume-name*}
 
 Repairs a storage volume on a node. Only LVM volume groups can be
 repaired at this time. They have the storage type "lvm-vg".
 

-On LVM volume groups, **repair-storage** runs "vgreduce
---removemissing".
+On LVM volume groups, **repair-storage** runs ``vgreduce
+--removemissing``.

 
 
 
 
 
 

@@ -471,14 +509,14 @@ POWERCYCLE
 
 **powercycle** [``--yes``] [``--force``] {*node*}
 
 
 **powercycle** [``--yes``] [``--force``] {*node*}
 

-This commands (tries to) forcefully reboot a node. It is a command
-that can be used if the node environemnt is broken, such that the
-admin can no longer login over ssh, but the Ganeti node daemon is
+This command (tries to) forcefully reboot a node. It is a command
+that can be used if the node environment is broken, such that the
+admin can no longer login over SSH, but the Ganeti node daemon is

 still working.
 
 Note that this command is not guaranteed to work; it depends on the
 hypervisor how effective is the reboot attempt. For Linux, this
 still working.
 
 Note that this command is not guaranteed to work; it depends on the
 hypervisor how effective is the reboot attempt. For Linux, this

-command require that the kernel option CONFIG\_MAGIC\_SYSRQ is
+command requires the kernel option ``CONFIG_MAGIC_SYSRQ`` to be

 enabled.
 
 The ``--yes`` option can be used to skip confirmation, while the
 enabled.
 
 The ``--yes`` option can be used to skip confirmation, while the

@@ -489,33 +527,48 @@ POWER
 ~~~~~
 
 **power** [``--force``] [``--ignore-status``] [``--all``]
 ~~~~~
 
 **power** [``--force``] [``--ignore-status``] [``--all``]

-on|off|cycle|status [*nodes*]
+[``--power-delay``] on|off|cycle|status [*nodes*]

 
 

-This commands calls out to out-of-band management to change the power
+This command calls out to out-of-band management to change the power

 state of given node. With ``status`` you get the power status as reported
 state of given node. With ``status`` you get the power status as reported

-by the out-of-band management script.
+by the out-of-band managment script.
+
+Note that this command will only work if the out-of-band functionality
+is configured and enabled on the cluster. If this is not the case,
+please use the **powercycle** command above.
+
+Using ``--force`` you skip the confirmation to do the operation.
+Currently this only has effect on ``off`` and ``cycle``. On those two
+you can *not* operate on the master. However, the command will provide
+you with the command to invoke to operate on the master nerver-mind.
+This is considered harmful and Ganeti does not support the use of it.

 
 

-Using ``--force`` you skip the confirmation to do the operation. Currently this
-only has effect on ``off`` and ``cycle``. On those two you can *not* operate on
-the master. However, the command will provide you with the command to invoke to
-operate on the master nerver-mind. This is considered harmful and Ganeti does
-not support the use of it.
+Providing ``--ignore-status`` will ignore the offline=N state of a node
+and continue with power off.

 
 

-Providing ``--ignore-status`` will ignore the offline=N state of a node and
-continue with power off.
+``--power-delay`` specifies the time in seconds (factions allowed)
+waited between powering on the next node. This is by default 2 seconds
+but can increased if needed with this option.
+
+*nodes* are optional. If not provided it will call out for every node in
+the cluster. Except for the ``off`` and ``cycle`` command where you've
+to explicit use ``--all`` to select all.

 
 

-*nodes* are optional. If not provided it will call out for every node in the
-cluster. Except for the ``off`` and ``cycle`` command where you've to explicit
-use ``-all`` to select all.

 
 HEALTH
 ~~~~~~
 
 **health** [*nodes*]
 
 
 HEALTH
 ~~~~~~
 
 **health** [*nodes*]
 

-This commands calls out to out-pf-band management to ask for the health status
+This command calls out to out-of-band management to ask for the health status

 of all or given nodes. The health contains the node name and then the items
 element with their status in a ``item=status`` manner. Where ``item`` is script
 specific and ``status`` can be one of ``OK``, ``WARNING``, ``CRITICAL`` or
 ``UNKNOWN``. Items with status ``WARNING`` or ``CRITICAL`` are logged and
 annotated in the command line output.
 of all or given nodes. The health contains the node name and then the items
 element with their status in a ``item=status`` manner. Where ``item`` is script
 specific and ``status`` can be one of ``OK``, ``WARNING``, ``CRITICAL`` or
 ``UNKNOWN``. Items with status ``WARNING`` or ``CRITICAL`` are logged and
 annotated in the command line output.

+
+.. vim: set textwidth=72 :
+.. Local Variables:
+.. mode: rst
+.. fill-column: 72
+.. End: