Merge branch 'devel-2.6' into submit

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

diff --git a/man/gnt-node.rst b/man/gnt-node.rst
index 15b663c..41eb1e0 100644 (file)
--- a/man/gnt-node.rst
+++ b/man/gnt-node.rst
@@ -23,12 +23,12 @@ COMMANDS
 ADD
 ~~~
 
 ADD
 ~~~
 

-| **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*]
+| **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.

@@ -64,6 +64,13 @@ 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.
 
 ``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::
 
     # gnt-node add node5.example.com
 Example::
 
     # gnt-node add node5.example.com

@@ -74,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.

@@ -88,9 +95,10 @@ interpreted as stdin.
 EVACUATE
 ~~~~~~~~
 
 EVACUATE
 ~~~~~~~~
 

-**evacuate** [-f] [--early-release] [--iallocator *NAME* \|
---new-secondary *destination\_node*]
-[--primary-only \| --secondary-only] [--early-release] {*node*}
+| **evacuate** [-f] [\--early-release] [\--submit]
+| [{-I|\--iallocator} *NAME* \| {-n|\--new-secondary} *destination\_node*]
+| [{-p|\--primary-only} \| {-s|\--secondary-only} ]
+|  {*node*}

 
 This command will move instances away from the given node. If
 ``--primary-only`` is given, only primary instances are evacuated, with
 
 This command will move instances away from the given node. If
 ``--primary-only`` is given, only primary instances are evacuated, with

@@ -120,11 +128,19 @@ potential recovery).
 Note that this command is equivalent to using per-instance commands for
 each affected instance individually:
 
 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``
+- ``--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
 
 - ``--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
 

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

 Example::
 
     # gnt-node evacuate -I hail node3.example.com
 Example::
 
     # gnt-node evacuate -I hail node3.example.com

@@ -133,7 +149,7 @@ Example::
 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

@@ -162,9 +178,9 @@ LIST
 ~~~~
 
 | **list**
 ~~~~
 
 | **list**

-| [--no-headers] [--separator=*SEPARATOR*]
-| [--units=*UNITS*] [-v] [{-o|--output} *[+]FIELD,...*]
-| [--filter]
+| [\--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.

@@ -219,6 +235,37 @@ If no node names are given, then all nodes are queried. Otherwise,
 only the given nodes will be listed.
 
 
 only the given nodes will be listed.
 
 

+LIST-DRBD
+~~~~~~~~~
+
+**list-drbd** [\--no-headers] [\--separator=*SEPARATOR*] node
+
+Lists the mapping of DRBD minors for a given node. This outputs a static
+list of fields (it doesn't accept the ``--output`` option), as follows:
+
+``Node``
+  The (full) name of the node we are querying
+``Minor``
+  The DRBD minor
+``Instance``
+  The instance the DRBD minor belongs to
+``Disk``
+  The disk index that the DRBD minor belongs to
+``Role``
+  Either ``primary`` or ``secondary``, denoting the role of the node for
+  the instance (note: this is not the live status of the DRBD device,
+  but the configuration value)
+``PeerNode``
+  The node that the minor is connected to on the other end
+
+This command can be used as a reverse lookup (from node and minor) to a
+given instance, which can be useful when debugging DRBD issues.
+
+Note that this command queries Ganeti via :manpage:`ganeti-confd(8)`, so
+it won't be available if support for ``confd`` has not been enabled at
+build time; furthermore, in Ganeti 2.6 this is only available via the
+Haskell version of confd (again selected at build time).
+

 LIST-FIELDS
 ~~~~~~~~~~~
 
 LIST-FIELDS
 ~~~~~~~~~~~
 

@@ -237,20 +284,23 @@ List the tags of the given node.
 MIGRATE
 ~~~~~~~
 
 MIGRATE
 ~~~~~~~
 

-**migrate** [-f] [--non-live] [--migration-mode=live\|non-live]
-[--ignore-ipolicy] {*node*}
+| **migrate** [-f] [\--non-live] [\--migration-mode=live\|non-live]
+| [\--ignore-ipolicy] [\--submit] {*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.
 
 
 If ``--ignore-ipolicy`` is given any instance policy violations occuring
 during this operation are ignored.
 

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

 Example::
 
     # gnt-node migrate node1.example.com
 Example::
 
     # gnt-node migrate node1.example.com

@@ -259,21 +309,21 @@ Example::
 MODIFY
 ~~~~~~
 
 MODIFY
 ~~~~~~
 

-| **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*]
+| **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
 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
 | {*node*}
 
 This command changes the role of the node. Each options takes
 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).
+manpage **ganeti(7)**.

 
 The option ``--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.

@@ -294,7 +344,15 @@ candidate role if is in that role)::
 
 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
 
 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.
+operation is taking place. Remember that the secondary ip must be
+reachable from the master secondary ip, when being changed, so be sure
+that the node has the new IP already configured and active. In order to
+convert a cluster from single homed to multi-homed or vice versa
+``--force`` is needed as well, and the target node for the first change
+must be the master.
+
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.

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

@@ -317,7 +375,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.

@@ -331,8 +389,8 @@ be interpreted as stdin.
 VOLUMES
 ~~~~~~~
 
 VOLUMES
 ~~~~~~~
 

-| **volumes** [--no-headers] [--human-readable]
-| [--separator=*SEPARATOR*] [{-o|--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)

@@ -384,9 +442,9 @@ Example::
 LIST-STORAGE
 ~~~~~~~~~~~~
 
 LIST-STORAGE
 ~~~~~~~~~~~~
 

-| **list-storage** [--no-headers] [--human-readable]
-| [--separator=*SEPARATOR*] [--storage-type=*STORAGE\_TYPE*]
-| [{-o|--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

@@ -455,8 +513,8 @@ Example::
 MODIFY-STORAGE
 ~~~~~~~~~~~~~~
 
 MODIFY-STORAGE
 ~~~~~~~~~~~~~~
 

-**modify-storage** [``--allocatable=yes|no``]
-{*node*} {*storage-type*} {*volume-name*}
+| **modify-storage** [\--allocatable={yes|no}] [\--submit]
+| {*node*} {*storage-type*} {*volume-name*}

 
 Modifies storage volumes on a node. Only LVM physical volumes can
 be modified at the moment. They have a storage type of "lvm-pv".
 
 Modifies storage volumes on a node. Only LVM physical volumes can
 be modified at the moment. They have a storage type of "lvm-pv".

@@ -469,14 +527,14 @@ Example::
 REPAIR-STORAGE
 ~~~~~~~~~~~~~~
 
 REPAIR-STORAGE
 ~~~~~~~~~~~~~~
 

-**repair-storage** [--ignore-consistency] {*node*} {*storage-type*}
-{*volume-name*}
+| **repair-storage** [\--ignore-consistency] ]\--submit]
+| {*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".
 
 
 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``.

 
 
 
 
 
 

@@ -495,7 +553,7 @@ Example::
 POWERCYCLE
 ~~~~~~~~~~
 
 POWERCYCLE
 ~~~~~~~~~~
 

-**powercycle** [``--yes``] [``--force``] {*node*}
+**powercycle** [\--yes] [\--force] [\--submit] {*node*}

 
 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
 
 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

@@ -511,6 +569,9 @@ The ``--yes`` option can be used to skip confirmation, while the
 ``--force`` option is needed if the target node is the master
 node.
 
 ``--force`` option is needed if the target node is the master
 node.
 

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

 POWER
 ~~~~~
 
 POWER
 ~~~~~