X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/1d65264b1937c2394405a70547e4fb5ac7c3f5ef..e2736e40ee13ad94b9dad1eafa44d97dcfcf2fff:/man/gnt-instance.sgml diff --git a/man/gnt-instance.sgml b/man/gnt-instance.sgml index d56a242..2d4c2cb 100644 --- a/man/gnt-instance.sgml +++ b/man/gnt-instance.sgml @@ -2,7 +2,7 @@ - February 11, 2009"> + January 22, 2010"> 8"> @@ -22,6 +22,7 @@ 2007 2008 2009 + 2010 Google Inc. &dhdate; @@ -74,13 +75,17 @@ - --disk=N:size=VAL,mode=ro|rw + --disk=N: + size=VAL + adopt=LV + ,mode=ro|rw -s SIZE --no-ip-check --no-name-check --no-start + --no-install --net=N:options @@ -125,16 +130,29 @@ The option specifies the parameters for the disks of the instance. The numbering of disks starts at zero, and at least one disk needs to be passed. For each - disk, at least the size needs to be given, and optionally - the access mode (read-only or the default of read-write) can - also be specified. The size is interpreted (when no unit is - given) in mebibytes. You can also use one of the suffixes + disk, either the size or the adoption source needs to be + given, and optionally the access mode (read-only or the + default of read-write) can also be specified. The size is + interpreted (when no unit is given) in mebibytes. You can + also use one of the suffixes m, g or t to specificy the exact the units used; these suffixes map to mebibytes, gibibytes and tebibytes. + When using the key in the disk + definition, Ganeti will reuse those volumes (instead of + creating new ones) as the instance's disks. Ganeti will + rename these volumes to the standard format, and (without + installing the OS) will use them as-is for the + instance. This allows migrating instances from non-managed + mode (e.q. plain KVM with LVM) to being managed via + Ganeti. Note that this works only for the `plain' disk + template (see below for template details). + + + Alternatively, a single-disk instance can be created via the option which takes a single argument, the size of the disk. This is similar to the Ganeti 1.2 @@ -226,7 +244,13 @@ The options specifies the operating system to be installed. The available operating systems can - be listed with gnt-os list. + be listed with gnt-os + list. Passing will + however skip the OS installation, allowing a manual import + if so desired. Note that the no-installation mode will + automatically disable the start-up of the instance (without + an OS, it most likely won't be able to start-up + successfully). @@ -329,6 +353,16 @@ interpreted as 'dc'. + + For KVM the boot order is either + cdrom, disk or + network. Please note that older + versions of KVM couldn't netboot from virtio + interfaces. This has been fixed in more recent + versions and is confirmed to work at least with + qemu-kvm 0.11.1. + + @@ -557,9 +591,9 @@ option to KVM, or one of the KVM cache modes: none (for direct I/O), writethrough (to use the host cache but report completion to the guest only when the host - has commited the changes to disk) or writeback (to use - the host cache and report completion as soon as the - data is in the host cache). Note that there are + has committed the changes to disk) or writeback (to + use the host cache and report completion as soon as + the data is in the host cache). Note that there are special considerations for the cache mode depending on version of KVM used and disk type (always raw file under Ganeti), please refer to the KVM documentation @@ -568,6 +602,80 @@ + + security_model + + Valid for the KVM hypervisor. + + The security model for kvm. Currently one of + none, user or + pool. Under none, the + default, nothing is done and instances are run as + the ganeti daemon user (normally root). + + + Under user kvm will drop + privileges and become the user specified by the + security_domain parameter. + + + Under pool a global cluster + pool of users will be used, making sure no two + instances share the same user on the same node. + (this mode is not implemented yet) + + + + + + + security_domain + + Valid for the KVM hypervisor. + + Under security model user the username to + run the instance under. It must be a valid username + existing on the host. + + Cannot be set under security model none + or pool. + + + + + + + kvm_flag + + Valid for the KVM hypervisor. + + If enabled the -enable-kvm flag is + passed to kvm. If disabled -disable-kvm is + passed. If unset no flag is passed, and the default running + mode for your kvm binary will be used. + + + + + + + migration_downtime + + Valid for the KVM hypervisor. + + The maximum amount of time (in ms) a KVM instance is + allowed to be frozen during a live migration, in order to copy + dirty memory pages. Default value is 30ms, but you may need to + increase this value for busy instances. + + + This option is only effective with kvm versions >= 87 + and qemu-kvm versions >= 0.11.0. + + + + + @@ -907,6 +1015,7 @@ instance5: 11225 --no-headers --separator=SEPARATOR -o [+]FIELD,... + --roman instance @@ -924,6 +1033,11 @@ instance5: 11225 + The option allows latin people to better + understand the cluster instances' status. + + + The option takes a comma-separated list of output fields. The available fields and their meaning are: @@ -1281,6 +1395,7 @@ instance5: 11225 -s --static + --roman --all instance @@ -1302,8 +1417,15 @@ instance5: 11225 Use the to get info about all instances, - rather than explicitely passing the ones you're interested in. + rather than explicitly passing the ones you're interested in. + + + + The option can be used to cause envy among + people who like ancient cultures, but are stuck with non-latin-friendly + cluster virtualization technologies. + @@ -1329,6 +1451,15 @@ instance5: 11225 + -t + plain + drbd + + + + --os-name=OS --force-variant + + --submit instance @@ -1348,6 +1479,13 @@ instance5: 11225 + The option will change the disk template + of the instance. Currently only conversions between the + plain and drbd disk templates are supported, and the + instance must be stopped before attempting the conversion. + + + The option adds a disk to the instance. The + The option will change the OS + name for the instance (without reinstallation). In case an + OS variant is specified that is not found, then by default + the modification is refused, + unless is passed. An + invalid OS will also be refused, unless + the option is given. + + + 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 @@ -1491,6 +1639,10 @@ instance5: 11225 --primary --secondary --all + --tags + --node-tags + --pri-node-tags + --sec-node-tags -H @@ -1544,6 +1696,36 @@ instance5: 11225 arguments accepted) + + --tags + + will start all instances in the cluster with + the tags given as arguments + + + + --node-tags + + will start all instances in the cluster on + nodes with the tags given as arguments + + + + --pri-node-tags + + will start all instances in the cluster on + primary nodes with the tags given as + arguments + + + + --sec-node-tags + + will start all instances in the cluster on + secondary nodes with the tags given as + arguments + + @@ -1618,6 +1800,10 @@ instance5: 11225 --primary --secondary --all + --tags + --node-tags + --pri-node-tags + --sec-node-tags --submit @@ -1642,8 +1828,10 @@ instance5: 11225 The , , - , and - options are similar as for the + , , + , , + , and + options are similar as for the startup command and they influence the actual instances being shutdown. @@ -1685,6 +1873,10 @@ instance5: 11225 --primary --secondary --all + --tags + --node-tags + --pri-node-tags + --sec-node-tags --submit @@ -1711,8 +1903,10 @@ instance5: 11225 The , , - , and - options are similar as for the + , , + , , + , and + options are similar as for the startup command and they influence the actual instances being rebooted. @@ -1781,6 +1975,7 @@ instance5: 11225 replace-disks --submit + --early-release -p --disks idx instance @@ -1789,6 +1984,7 @@ instance5: 11225 replace-disks --submit + --early-release -s --disks idx instance @@ -1797,6 +1993,7 @@ instance5: 11225 replace-disks --submit + --early-release --iallocator name --new-secondary NODE @@ -1808,6 +2005,7 @@ instance5: 11225 replace-disks --submit + --early-release --auto instance @@ -1859,6 +2057,19 @@ instance5: 11225 + The changes the code so + that the old storage on secondary node(s) is removed early + (before the resync is completed) and the internal Ganeti + locks for the current (and new, if any) secondary node are + also released, thus allowing more parallelism in the cluster + operation. This should be used only when recovering from a + disk failure on the current secondary (thus the 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). + + + Note that it is not possible to select an offline or drained node as a new secondary.