X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/a8083063386109da1f7d95cb441152cad79bc15f..1b54fc6c2fd92b614c029cc5312d02f9f1526253:/man/gnt-node.sgml?ds=inline
diff --git a/man/gnt-node.sgml b/man/gnt-node.sgml
index f0d0119..f00440d 100644
--- a/man/gnt-node.sgml
+++ b/man/gnt-node.sgml
@@ -2,7 +2,7 @@
- June 20, 2007">
+ February 12, 2009">
8">
@@ -20,6 +20,8 @@
20062007
+ 2008
+ 2009Google Inc.
&dhdate;
@@ -28,7 +30,7 @@
&dhucpackage;
&dhsection;
- ganeti 1.2
+ ganeti 2.0&dhpackage;
@@ -60,6 +62,7 @@
add
+ --readd-s secondary_ipnodename
@@ -92,6 +95,15 @@
+ In case you're readding a node after hardware failure, you can
+ use the parameter. In this case, you
+ don't need to pass the secondary IP again, it will reused from
+ the cluster. Also, the drained and
+ offline flags of the node will be cleared
+ before re-adding it.
+
+
+
Example:
# gnt-node add node5.example.com
@@ -101,6 +113,105 @@
+ ADD-TAGS
+
+
+ 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.
+
+
+
+ If the option is given, the list of
+ tags will be extended with the contents of that file (each
+ line becomes a tag). In this case, there is not need to pass
+ tags on the command line (if you do, both sources will be
+ used). A file name of - will be interpreted as stdin.
+
+
+
+
+ EVACUATE
+
+
+ evacuate
+ -f
+
+ --iallocator NAME
+ --new-secondary destination_node
+
+ node
+
+
+
+ This command will move all secondary instances away from the
+ given node. It works only for instances having a drbd disk
+ template.
+
+
+
+ The new location for the instances can be specified in two ways:
+
+
+ as a single node for all instances, via the
+ option
+
+
+ or via the option,
+ giving a script name as parameter, so each instance will
+ be in turn placed on the (per the script) optimal
+ node
+
+
+
+
+
+ Example:
+
+ # gnt-node evacuate -I dumb node3.example.com
+
+
+
+
+
+ FAILOVER
+
+
+ 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 a drbd disk template.
+
+
+
+ Normally the failover will check the consistency of the disks
+ before failing over the instance. If you are trying to migrate
+ instances off a dead node, this will fail. Use the
+ option for this purpose.
+
+
+
+ Example:
+
+ # gnt-node failover node1.example.com
+
+
+
+
+ INFO
@@ -120,17 +231,19 @@
list
+ --sync
+ --no-headers--separator=SEPARATOR
- -o FIELD,...
+
+ --units=UNITS
+ -o [+]FIELD,...
+
+ node
- Lists the nodes in the cluster. If you give the
- option, the output contains just
- the node name, primary ip and secondary ip. In case the
- secondary ip is the same as the primary one, it will be listed
- as "-".
+ Lists the nodes in the cluster.
@@ -141,6 +254,24 @@
+ The units used to display the numeric values in the output
+ varies, depending on the options given. By default, the values
+ will be formatted in the most appropriate unit. If the
+ option is given, then the values
+ are shown in mebibytes to allow parsing by scripts. In both
+ cases, the option can be used to
+ enforce a given output unit.
+
+
+
+ By default, the query of nodes will be done in parallel with
+ any running jobs. This might give inconsistent results for the
+ free disk/memory. The can be used to
+ grab locks for all the nodes and ensure consistent view of the
+ cluster (but this might stall the query for a long time).
+
+
+
The option takes a comma-separated list of
output fields. The available fields and their meaning are:
@@ -151,20 +282,34 @@
- pinst
+ pinst_cntthe number of instances having this node as
primary
- sinst
+ pinst_list
+
+ the list of instances having this node as
+ primary, comma separated
+
+
+
+ sinst_cntthe number of instances having this node as a
secondary node
+ sinst_list
+
+ the list of instances having this node as a
+ secondary node, comma separated
+
+
+ pipthe primary ip of this node (used for cluster
@@ -215,12 +360,83 @@
allocations
+
+ bootid
+
+ the node bootid value; this is a linux specific
+ feature that assigns a new UUID to the node at each boot
+ and can be use to detect node reboots (by tracking
+ changes in this value)
+
+
+
+ tags
+
+ comma-separated list of the node's
+ tags
+
+
+
+ serial_no
+
+ the so called 'serial number' of the instance;
+ this is a numeric field that is incremented each time
+ the instance is modified, and it can be used to detect
+ modifications
+
+
+
+ ctotal
+
+ the toal number of logical processors
+
+
+
+ cnodes
+
+ the number of NUMA domains on the node, if the
+ hypervisor can export this information
+
+
+
+ csockets
+
+ the number of physical CPU sockets, if the
+ hypervisor can export this information
+
+
+
+ master_candidate
+
+ whether the node is a master candidate or not
+
+
+
+ drained
+
+ whether the node is drained or not
+
+
+
+ offline
+
+ whether the node is offline or not
+
+
+ If the value of the option starts with the character
+ +, the new fields will be added to the
+ default list. This allows to quickly 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 (
+ of the cluster (e.g. namepinstsinstpipsip and thus the master does
@@ -235,9 +451,100 @@
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
- (UML), whereas others have separate memory
+ (KVM), whereas others have separate memory
for the node and for the instances (Xen).
+
+
+ If no node names are given, then all nodes are
+ queried. Otherwise, only the given nodes will be listed.
+
+
+
+
+ LIST-TAGS
+
+
+ list-tags
+ nodename
+
+
+ List the tags of the given node.
+
+
+
+ MIGRATE
+
+ migrate
+ -f
+ --non-live
+ 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 option can be given to do a
+ non-live migration.
+
+
+
+ Example:
+
+ # gnt-node migrate node1.example.com
+
+
+
+
+
+
+ MODIFY
+
+ modify
+ -f
+ --submit
+ --master-candidate=
+ --drained=
+ --offline=
+ 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 are described
+ in the manpage
+ ganeti7
+ .
+
+
+
+ In case a node is demoted from the master candidate role, but
+ there are not enough new nodes for this case, the operation
+ will be refused. To override this check, pass the
+ option.
+
+
+
+ Example (setting a node offline, which will demote it from
+ master candidate role if is in that role):
+
+# gnt-node modify --offline=yes node1.example.com
+
+
+
+ Example (setting the node back to online and master candidate):
+
+# gnt-node modify --offline=no --master-candidate=yes node1.example.com
+
+
+
@@ -261,6 +568,152 @@
+
+ REMOVE-TAGS
+
+ 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.
+
+
+
+ If the option is given, the list of
+ tags will be extended with the contents of that file (each
+ line becomes a tag). In this case, there is not need to pass
+ tags on the command line (if you do, both sources will be
+ used). A file name of - will be interpreted as stdin.
+
+
+
+
+ VOLUMES
+
+
+ volumes
+ --no-headers
+ --human-readable
+ --separator=SEPARATOR
+ --output=FIELDS
+
+ node
+
+
+
+ Lists all logical volumes and their physical disks from the node(s)
+ provided.
+
+
+
+ The option will skip the initial
+ header line. The option takes an
+ argument which denotes what will be used between the output
+ fields. Both these options are to help scripting.
+
+
+
+ The units used to display the numeric values in the output
+ varies, depending on the options given. By default, the values
+ will be formatted in the most appropriate unit. If the
+ option is given, then the values
+ are shown in mebibytes to allow parsing by scripts. In both
+ cases, the option can be used to
+ enforce a given output unit.
+
+
+
+ The 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
+
+
+
+ phys
+
+ the physical drive (on which the LVM physical
+ volume lives)
+
+
+
+ vg
+
+ the volume group name
+
+
+
+ name
+
+ the logical volume name
+
+
+
+ size
+
+ the logical volume size
+
+
+
+ instance
+
+ The name of the instance to which this volume
+ belongs, or (in case it's an orphan volume) the
+ character -
+
+
+
+
+
+
+ Example:
+
+# gnt-node volumes node5.example.com
+Node PhysDev VG Name Size Instance
+node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11000.meta 128 instance1.example.com
+node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256 instance1.example.com
+
+
+
+
+
+ POWERCYCLE
+
+
+ powercycle
+
+
+ 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 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 enabled.
+
+
+
+ The option can be used to skip
+ confirmation, while the option is
+ needed if the target node is the master node.
+
+
&footer;