X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/75f49d9be1016cae525829e66b80ba35ca98f842..b6a30b0daecf3030fc991f070d09cce6741db5bf:/man/gnt-cluster.sgml
diff --git a/man/gnt-cluster.sgml b/man/gnt-cluster.sgml
index 6b0cc71..6c8f4e7 100644
--- a/man/gnt-cluster.sgml
+++ b/man/gnt-cluster.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;
@@ -56,6 +58,30 @@
COMMANDS
+ ADD-TAGS
+
+
+ add-tags
+ --from file
+ tag
+
+
+
+ Add tags to the cluster. 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.
+
+
+
+ COMMAND
@@ -78,6 +104,21 @@
+ The command is executed serially on the selected nodes. If the
+ master node is present in the list, the command will be
+ executed last on the master. Regarding the other nodes, the
+ execution order is somewhat alphabetic, so that
+ node2.example.com will be earlier than node10.example.com but
+ after node1.example.com.
+
+
+
+ So given the node names node1, node2, node3, node10, node11,
+ with node3 being the master, the order will be: node1, node2,
+ node10, node11, node3.
+
+
+
The command is constructed by concatenating all other command
line arguments. For example, to list the contents of the
/etc directory on all
@@ -124,6 +165,7 @@
destroy
+ --yes-do-it
@@ -131,6 +173,11 @@
a gnt-cluster init can be done again
afterwards.
+
+
+ Since this is a dangerous command, you are required to pass
+ the argument --yes-do-it.
+
@@ -163,8 +210,29 @@
init
+ -s secondary_ip
+ -b bridge
+
+ -g vg-name
+
+ --master-netdev vg-name
+
+ -m mac-prefix
+
+ --no-lvm-storage
+
+ --file-storage-dir dir
+
+ --enabled-hypervisors hypervisors
+
+ -t hypervisor name
+
+ --hypervisor-parameters hypervisor:hv-param=value,hv-param=value
+
+ --backend-parameters be-param=value,be-param=value
+ clustername
@@ -178,7 +246,8 @@
Note that the clustername is not
any random name. It has to be resolvable to an IP address
using DNS, and it is best if you give the fully-qualified
- domain name.
+ domain name. This hostname must resolve to an IP address
+ reserved exclusively for this purpose.
@@ -196,7 +265,6 @@
Note that for Ganeti it doesn't matter if the secondary
-
network is actually a separate physical network, or is done
using tunneling, etc. For performance reasons, it's
recommended to use a separate network, of course.
@@ -206,6 +274,167 @@
The option specifies the default bridge
for instances.
+
+
+ The option will let you specify a volume group
+ different than 'xenvg' for ganeti to use when creating instance disks.
+ This volume group must have the same name on all nodes. Once the
+ cluster is initialized this can be altered by using the
+ modify command. If you don't want to use lvm
+ storage at all use the option.
+ Once the cluster is initialized you can change this setup with the
+ modify command.
+
+
+
+ The option is useful for specifying a
+ different interface on which the master will activate its IP address.
+ It's important that all nodes have this interface because you'll need
+ it for a master failover.
+
+
+
+ The option will let you specify a three byte prefix
+ under which the virtual MAC addresses of your instances will be
+ generated. The prefix must be specified in the format XX:XX:XX and the
+ default is aa:00:00.
+
+
+
+ The allows you to initialize the
+ cluster without lvm support. This means that only instances using
+ files as storage backend will be possible to create. Once the cluster
+ is initialized you can change this setup with the
+ modify command.
+
+
+
+ The option allows you
+ set the directory to use for storing the instance disk
+ files when using file storage as backend for instance disks.
+
+
+
+ The option allows you
+ to set the list of hypervisors that will be enabled for
+ this cluster. Instance hypervisors can only be choosen from
+ the list of enabled hypervisors. Currently, the following
+ hypervisors are available:
+
+
+
+
+
+ xen-pvm
+
+
+ Xen PVM hypervisor
+
+
+
+
+ xen-hvm
+
+
+ Xen HVM hypervisor
+
+
+
+
+ kvm
+
+
+ Linux KVM hypervisor
+
+
+
+
+ fake
+
+
+ fake hypervisor for development/testing
+
+
+
+
+
+
+
+ Either a single hypervisor name or a comma-separated list of
+ hypervisor names can be specified. If this option is not
+ specified, only the xen-pvm hypervisor is enabled by default.
+
+
+
+ With the option, the default hypervisor
+ can be set. It has to be a member of the list of enabled
+ hypervisors. If not specified, the first entry on the list of
+ enabled hypervisors will be used by default.
+
+
+
+ The option allows you to set
+ the default backend parameters for the cluster. The parameter
+ format is a comma-separated list of key=value pairs with the
+ following supported keys:
+
+
+
+
+
+ vcpus
+
+
+ Number of VCPUs to set for an instance by default, must
+ be an integer, will be set to 1 if no specified.
+
+
+
+
+ memory
+
+
+ Amount of memory to allocate for an instance by default,
+ can be either an integer or an integer followed by a
+ unit (M for mebibytes and G for gibibytes are
+ supported), will be set to 128M if not specified.
+
+
+
+
+ auto_balance
+
+
+ Value of the auto_balance flag for instances to use by
+ default, will be set to true if not specified.
+
+
+
+
+
+
+
+ The option allows you
+ to set default hypervisor specific parameters for the
+ cluster. The format of this option is the name of the
+ hypervisor, followed by a colon and a comma-separated list of
+ key=value pairs. The keys available for each hypervisors are
+ detailed int the
+ gnt-instance
+ 8 man page, in the
+ add command.
+
+
+
+
+
+ LIST-TAGS
+
+
+ list-tags
+
+
+ List the tags of the cluster.
@@ -221,6 +450,131 @@
+ MODIFY
+
+
+ modify
+
+ -g vg-name
+
+ --no-lvm-storage
+
+ --enabled-hypervisors
+ hypervisors
+
+ --hypervisor-parameters hypervisor:hv-param=value,hv-param=value
+
+ --backend-parameters be-param=value,be-param=value
+
+ -C candidate_pool_size
+
+
+
+
+ Modify the options for the cluster.
+
+
+
+ The , ,
+ ,
+ and
+ options are
+ described in the init command.
+
+
+
+ The options specifies the
+ candidate_pool_size cluster parameter. This
+ is the number of nodes that the master will try to keep as
+ master_candidates. For more details about
+ this role and other node roles, see the
+ ganeti7
+ . If you increase the size, the master will
+ automatically promote as many nodes as required and possible
+ to reach the intended number.
+
+
+
+
+ QUEUE
+
+
+ queue
+ drain
+ undrain
+ info
+
+
+
+
+ Change job queue properties.
+
+
+
+ The option sets the drain flag on the
+ job queue. No new jobs will be accepted, but jobs already in
+ the queue will be processed.
+
+
+
+ The will unset the drain flag on the
+ job queue. New jobs will be accepted.
+
+
+
+ The option shows the properties of the
+ job queue.
+
+
+
+
+ redist-conf
+
+ redist-conf
+ --submit
+
+
+
+ This command forces a full push of configuration files from
+ the master node to the other nodes in the cluster. This is
+ normally not needed, but can be run if the
+ verify complains about configuration
+ mismatches.
+
+
+
+ The option is used to send the job
+ to the master daemon but not wait for its completion. The job
+ ID will be shown so that it can be examined via
+ gnt-job info.
+
+
+
+
+ REMOVE-TAGS
+
+
+ remove-tags
+ --from file
+ tag
+
+
+
+ Remove tags from the cluster. If any of the tags are not
+ existing on the cluster, 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.
+
+
+
+ RENAME
@@ -244,10 +598,47 @@
+ SEARCH-TAGS
+
+
+ search-tags
+ pattern
+
+
+
+ Searches the tags on all objects in the cluster (the cluster
+ itself, the nodes and the instances) for a given pattern. The
+ pattern is interpreted as a regular expression and a search
+ will be done on it (i.e. the given pattern is not anchored to
+ the beggining of the string; if you want that, prefix the
+ pattern with ^).
+
+
+
+ If no tags are matching the pattern, the exit code of the
+ command will be one. If there is at least one match, the exit
+ code will be zero. Each match is listed on one line, the
+ object and the tag separated by a space. The cluster will be
+ listed as /cluster, a node will be listed
+ as
+ /nodes/name,
+ and an instance as
+ /instances/name.
+ Example:
+
+
+# gnt-cluster search time
+/cluster ctime:2007-09-01
+/nodes/node1.example.com mtime:2007-10-04
+
+
+
+ VERIFYverify
+ --no-nplus1-mem
@@ -255,6 +646,32 @@
respect to running instances, and incurs no downtime of the
instances.
+
+
+ If the option is given, ganeti won't
+ check whether if it loses a node it can restart all the instances on
+ their secondaries (and report an error otherwise).
+
+
+
+
+ VERIFY-DISKS
+
+
+ verify-disks
+
+
+
+ The command checks which instances have degraded DRBD disks
+ and activates the disks of those instances.
+
+
+
+ This command is run from the ganeti-watcher
+ tool, which also has a different, complementary algorithm for
+ doing this check. Together, these two should ensure that DRBD
+ disks are kept consistent.
+