X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/a71f835e3e57ff2456e201ba48e511861f49f2a7..fbdac0d912e794705b18637a611c9d87265c1501:/man/gnt-instance.rst diff --git a/man/gnt-instance.rst b/man/gnt-instance.rst index 051c966..b208954 100644 --- a/man/gnt-instance.rst +++ b/man/gnt-instance.rst @@ -27,19 +27,19 @@ ADD ^^^ | **add** -| {-t|--disk-template {diskless | file \| plain \| drbd \| rbd}} -| {--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*] -| \| {-s|--os-size} *SIZE*} -| [--no-ip-check] [--no-name-check] [--no-start] [--no-install] -| [--net=*N* [:options...] \| --no-nics] -| [{-B|--backend-parameters} *BEPARAMS*] -| [{-H|--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]] -| [{-O|--os-parameters} *param*=*value*... ] -| [--file-storage-dir *dir\_path*] [--file-driver {loop \| blktap}] -| {{-n|--node} *node[:secondary-node]* \| {-I|--iallocator} *name*} -| {{-o|--os-type} *os-type*} -| [--submit] -| [--ignore-ipolicy] +| {-t|\--disk-template {diskless | file \| plain \| drbd \| rbd}} +| {\--disk=*N*: {size=*VAL* \| adopt=*LV*}[,vg=*VG*][,metavg=*VG*][,mode=*ro\|rw*] +| \| {-s|\--os-size} *SIZE*} +| [\--no-ip-check] [\--no-name-check] [\--no-start] [\--no-install] +| [\--net=*N* [:options...] \| \--no-nics] +| [{-B|\--backend-parameters} *BEPARAMS*] +| [{-H|\--hypervisor-parameters} *HYPERVISOR* [: option=*value*... ]] +| [{-O|\--os-parameters} *param*=*value*... ] +| [\--file-storage-dir *dir\_path*] [\--file-driver {loop \| blktap}] +| {{-n|\--node} *node[:secondary-node]* \| {-I|\--iallocator} *name*} +| {{-o|\--os-type} *os-type*} +| [\--submit] +| [\--ignore-ipolicy] | {*instance*} Creates a new instance on the specified host. The *instance* argument @@ -190,9 +190,11 @@ boot\_order as 'dc'. For KVM the boot order is either "floppy", "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. + "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. Also note + that if you have set the ``kernel_path`` option, that will be used + for booting, and this setting will be silently ignored. blockdev\_prefix Valid for the Xen HVM and PVM hypervisors. @@ -385,6 +387,19 @@ spice\_use\_vdagent Enables or disables passing mouse events via SPICE vdagent. +cpu\_type + Valid for the KVM hypervisor. + + This parameter determines the emulated cpu for the instance. If this + parameter is empty (which is the default configuration), it will not + be passed to KVM. + + Be aware of setting this parameter to ``"host"`` if you have nodes + with different CPUs from each other. Live migration may stop working + in this situation. + + For more information please refer to the KVM manual. + acpi Valid for the Xen HVM and KVM hypervisors. @@ -411,9 +426,10 @@ kernel\_path Valid for the Xen PVM and KVM hypervisors. This option specifies the path (on the node) to the kernel to boot - the instance with. Xen PVM instances always require this, while - for KVM if this option is empty, it will cause the machine to load - the kernel from its disks. + the instance with. Xen PVM instances always require this, while for + KVM if this option is empty, it will cause the machine to load the + kernel from its disks (and the boot will be done accordingly to + ``boot_order``). kernel\_args Valid for the Xen PVM and KVM hypervisors. @@ -527,14 +543,49 @@ migration\_downtime versions >= 0.11.0. cpu\_mask - Valid for the LXC hypervisor. + Valid for the Xen, KVM and LXC hypervisors. The processes belonging to the given instance are only scheduled on the specified CPUs. - The parameter format is a comma-separated list of CPU IDs or CPU - ID ranges. The ranges are defined by a lower and higher boundary, - separated by a dash. The boundaries are inclusive. + The format of the mask can be given in three forms. First, the word + "all", which signifies the common case where all VCPUs can live on + any CPU, based on the hypervisor's decisions. + + Second, a comma-separated list of CPU IDs or CPU ID ranges. The + ranges are defined by a lower and higher boundary, separated by a + dash, and the boundaries are inclusive. In this form, all VCPUs of + the instance will be mapped on the selected list of CPUs. Example: + ``0-2,5``, mapping all VCPUs (no matter how many) onto physical CPUs + 0, 1, 2 and 5. + + The last form is used for explicit control of VCPU-CPU pinnings. In + this form, the list of VCPU mappings is given as a colon (:) + separated list, whose elements are the possible values for the + second or first form above. In this form, the number of elements in + the colon-separated list _must_ equal the number of VCPUs of the + instance. + + Example:: + + # Map the entire instance to CPUs 0-2 + gnt-instance modify -H cpu_mask=0-2 my-inst + + # Map vCPU 0 to physical CPU 1 and vCPU 1 to CPU 3 (assuming 2 vCPUs) + gnt-instance modify -H cpu_mask=1:3 my-inst + + # Pin vCPU 0 to CPUs 1 or 2, and vCPU 1 to any CPU + gnt-instance modify -H cpu_mask=1-2:all my-inst + + # Pin vCPU 0 to any CPU, vCPU 1 to CPUs 1, 3, 4 or 5, and CPU 2 to + # CPU 0 (backslashes for escaping the comma) + gnt-instance modify -H cpu_mask=all:1\\,3-5:0 my-inst + + # Pin entire VM to CPU 0 + gnt-instance modify -H cpu_mask=0 my-inst + + # Turn off CPU pinning (default setting) + gnt-instance modify -H cpu_mask=all my-inst usb\_mouse Valid for the KVM hypervisor. @@ -628,14 +679,12 @@ blktap better performance. Especially if you use a network file system (e.g. NFS) to store your instances this is the recommended choice. - -The ``--submit`` 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**. - 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-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \ @@ -743,8 +792,8 @@ follows:: REMOVE ^^^^^^ -**remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit] -[--force] {*instance*} +**remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit] +[\--force] {*instance*} Remove an instance. This will remove all data from the instance and there is *no way back*. If you are not sure if you use an instance @@ -761,12 +810,11 @@ before forcing the shutdown (e.g. ``xm destroy`` in Xen, killing the kvm process for KVM, etc.). By default two minutes are given to each instance to stop. -The ``--submit`` 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**. - The ``--force`` option is used to skip the interactive confirmation. +See **ganeti(7)** for a description of ``--submit`` and other common +options. + Example:: # gnt-instance remove instance1.example.com @@ -776,8 +824,8 @@ LIST ^^^^ | **list** -| [--no-headers] [--separator=*SEPARATOR*] [--units=*UNITS*] [-v] -| [{-o|--output} *[+]FIELD,...*] [--filter] [instance...] +| [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v] +| [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...] Shows the currently configured instances with memory usage, disk usage, the node they are running on, and their run status. @@ -837,7 +885,7 @@ Lists available fields for instances. INFO ^^^^ -**info** [-s \| --static] [--roman] {--all \| *instance*} +**info** [-s \| \--static] [\--roman] {\--all \| *instance*} Show detailed information about the given instance(s). This is different from **list** as it shows detailed data about the instance's @@ -858,18 +906,18 @@ MODIFY ^^^^^^ | **modify** -| [{-H|--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*] -| [{-B|--backend-parameters} *BACKEND\_PARAMETERS*] -| [{-m|--runtime-memory} *SIZE*] -| [--net add*[:options]* \| --net remove \| --net *N:options*] -| [--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| --disk remove \| -| --disk *N*:mode=*MODE*] -| [{-t|--disk-template} plain | {-t|--disk-template} drbd -n *new_secondary*] [--no-wait-for-sync] -| [--os-type=*OS* [--force-variant]] -| [{-O|--os-parameters} *param*=*value*... ] -| [--offline \| --online] -| [--submit] -| [--ignore-ipolicy] +| [{-H|\--hypervisor-parameters} *HYPERVISOR\_PARAMETERS*] +| [{-B|\--backend-parameters} *BACKEND\_PARAMETERS*] +| [{-m|\--runtime-memory} *SIZE*] +| [\--net add*[:options]* \| \--net remove \| \--net *N:options*] +| [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk remove \| +| \--disk *N*:mode=*MODE*] +| [{-t|\--disk-template} plain | {-t|\--disk-template} drbd -n *new_secondary*] [\--no-wait-for-sync] +| [\--os-type=*OS* [\--force-variant]] +| [{-O|\--os-parameters} *param*=*value*... ] +| [\--offline \| \--online] +| [\--submit] +| [\--ignore-ipolicy] | {*instance*} Modifies the memory size, number of vcpus, ip address, MAC address @@ -901,7 +949,7 @@ the default volume group to create the disk on. For DRBD disks, the ``metavg=``*VG* option specifies the volume group for the metadata device. ``--disk`` *N*``:add,size=``**SIZE** can be used to add a disk at a specific index. The ``--disk remove`` option will remove the -last disk of the instance. Use ``--disk ``*N*``:remove`` to remove a +last disk of the instance. Use ``--disk `` *N*``:remove`` to remove a disk by its index. The ``--disk`` *N*``:mode=``*MODE* option will change the mode of the Nth disk of the instance between read-only (``ro``) and read-write (``rw``). @@ -927,23 +975,22 @@ fails if the instance was not in the ``offline`` state, otherwise it changes instance's state to ``down``. These modifications take effect immediately. -The ``--submit`` 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**. - 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. + Most of the changes take effect at the next restart. If the instance is running, there is no effect on the instance. REINSTALL ^^^^^^^^^ -| **reinstall** [{-o|--os-type} *os-type*] [--select-os] [-f *force*] -| [--force-multiple] -| [--instance \| --node \| --primary \| --secondary \| --all] -| [{-O|--os-parameters} *OS\_PARAMETERS*] [--submit] {*instance*...} +| **reinstall** [{-o|\--os-type} *os-type*] [\--select-os] [-f *force*] +| [\--force-multiple] +| [\--instance \| \--node \| \--primary \| \--secondary \| \--all] +| [{-O|\--os-parameters} *OS\_PARAMETERS*] [\--submit] {*instance*...} Reinstalls the operating system on the given instance(s). The instance(s) must be stopped when running this command. If the ``-o @@ -962,14 +1009,13 @@ arguments or by using the ``--node``, ``--primary``, ``--secondary`` or ``--all`` options), the user must pass the ``--force-multiple`` options to skip the interactive confirmation. -The ``--submit`` 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**. +See **ganeti(7)** for a description of ``--submit`` and other common +options. RENAME ^^^^^^ -| **rename** [--no-ip-check] [--no-name-check] [--submit] +| **rename** [\--no-ip-check] [\--no-name-check] [\--submit] | {*instance*} {*new\_name*} Renames the given instance. The instance must be stopped when running @@ -985,9 +1031,8 @@ that the resolved name matches the provided name. Since the name check is used to compute the IP address, if you pass this option you must also pass the ``--no-ip-check`` option. -The ``--submit`` 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**. +See **ganeti(7)** for a description of ``--submit`` and other common +options. Starting/stopping/connecting to console ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -996,50 +1041,50 @@ STARTUP ^^^^^^^ | **startup** -| [--force] [--ignore-offline] -| [--force-multiple] [--no-remember] -| [--instance \| --node \| --primary \| --secondary \| --all \| -| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags] -| [{-H|--hypervisor-parameters} ``key=value...``] -| [{-B|--backend-parameters} ``key=value...``] -| [--submit] [--paused] +| [\--force] [\--ignore-offline] +| [\--force-multiple] [\--no-remember] +| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \| +| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags] +| [{-H|\--hypervisor-parameters} ``key=value...``] +| [{-B|\--backend-parameters} ``key=value...``] +| [\--submit] [\--paused] | {*name*...} Starts one or more instances, depending on the following options. The four available modes are: ---instance +\--instance will start the instances given as arguments (at least one argument required); this is the default selection ---node +\--node will start the instances who have the given node as either primary or secondary ---primary +\--primary will start all instances whose primary node is in the list of nodes passed as arguments (at least one node required) ---secondary +\--secondary will start all instances whose secondary node is in the list of nodes passed as arguments (at least one node required) ---all +\--all will start all instances in the cluster (no arguments accepted) ---tags +\--tags will start all instances in the cluster with the tags given as arguments ---node-tags +\--node-tags will start all instances in the cluster on nodes with the tags given as arguments ---pri-node-tags +\--pri-node-tags will start all instances in the cluster on primary nodes with the tags given as arguments ---sec-node-tags +\--sec-node-tags will start all instances in the cluster on secondary nodes with the tags given as arguments @@ -1075,16 +1120,16 @@ and the instance instance2 with 2GB of RAM (this time only, unless that is the actual instance memory size already). Note that the values override the instance parameters (and not extend them): an instance with "kernel\_args=ro" when started with -H kernel\_args=single will -result in "single", not "ro single". The ``--submit`` 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**. +result in "single", not "ro single". The ``--paused`` option is only valid for Xen and kvm hypervisors. This pauses the instance at the start of bootup, awaiting ``gnt-instance console`` to unpause it, allowing the entire boot process to be monitored for debugging. +See **ganeti(7)** for a description of ``--submit`` and other common +options. + Example:: # gnt-instance start instance1.example.com @@ -1096,11 +1141,11 @@ SHUTDOWN ^^^^^^^^ | **shutdown** -| [--timeout=*N*] -| [--force-multiple] [--ignore-offline] [--no-remember] -| [--instance \| --node \| --primary \| --secondary \| --all \| -| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags] -| [--submit] +| [\--timeout=*N*] +| [\--force-multiple] [\--ignore-offline] [\--no-remember] +| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \| +| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags] +| [\--submit] | {*name*...} Stops one or more instances. If the instance cannot be cleanly stopped @@ -1118,10 +1163,6 @@ The ``--instance``, ``--node``, ``--primary``, ``--secondary``, ``--sec-node-tags`` options are similar as for the **startup** command and they influence the actual instances being shutdown. -The ``--submit`` 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**. - ``--ignore-offline`` can be used to ignore offline primary nodes and force the instance to be marked as stopped. This option should be used with care as it can lead to an inconsistent cluster state. @@ -1135,6 +1176,9 @@ you just need to disable the watcher, shutdown all instances with ``--no-remember``, and when the watcher is activated again it will restore the correct runtime state for all instances. +See **ganeti(7)** for a description of ``--submit`` and other common +options. + Example:: # gnt-instance shutdown instance1.example.com @@ -1145,13 +1189,13 @@ REBOOT ^^^^^^ | **reboot** -| [{-t|--type} *REBOOT-TYPE*] -| [--ignore-secondaries] -| [--shutdown-timeout=*N*] -| [--force-multiple] -| [--instance \| --node \| --primary \| --secondary \| --all \| -| --tags \| --node-tags \| --pri-node-tags \| --sec-node-tags] -| [--submit] +| [{-t|\--type} *REBOOT-TYPE*] +| [\--ignore-secondaries] +| [\--shutdown-timeout=*N*] +| [\--force-multiple] +| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \| +| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags] +| [\--submit] | [*name*...] Reboots one or more instances. The type of reboot depends on the value @@ -1177,6 +1221,9 @@ to stop. The ``--force-multiple`` will skip the interactive confirmation in the case the more than one instance will be affected. +See **ganeti(7)** for a description of ``--submit`` and other common +options. + Example:: # gnt-instance reboot instance1.example.com @@ -1186,7 +1233,7 @@ Example:: CONSOLE ^^^^^^^ -**console** [--show-cmd] {*instance*} +**console** [\--show-cmd] {*instance*} Connects to the console of the given instance. If the instance is not up, an error is returned. Use the ``--show-cmd`` option to display the @@ -1212,17 +1259,17 @@ Disk management REPLACE-DISKS ^^^^^^^^^^^^^ -**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-p} -[--disks *idx*] {*instance*} +**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-p} +[\--disks *idx*] {*instance*} -**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-s} -[--disks *idx*] {*instance*} +**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] {-s} +[\--disks *idx*] {*instance*} -**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] -{--iallocator *name* \| -- {*instance*} +**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] +{{-I\|\--iallocator} *name* \| \--node *node* } {*instance*} -**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] -{--auto} {*instance*} +**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy] +{\--auto} {*instance*} This command is a generalized form for replacing disks. It is currently only valid for the mirrored (DRBD) disk template. @@ -1242,16 +1289,15 @@ selected automatically by the specified allocator plugin, otherwise the new secondary node will be the one chosen manually via the ``--new-secondary`` option. +Note that it is not possible to select an offline or drained node as a +new secondary. + The fourth form (when using ``--auto``) will automatically determine which disks of an instance are faulty and replace them within the same node. The ``--auto`` option works only when an instance has only faulty disks on either the primary or secondary node; it doesn't work when both sides have faulty disks. -The ``--submit`` 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**. - The ``--early-release`` 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) @@ -1265,13 +1311,13 @@ The ``--ignore-ipolicy`` let the command ignore instance policy violations if replace-disks changes groups and the instance would violate the new groups instance policy. -Note that it is not possible to select an offline or drained node as a -new secondary. +See **ganeti(7)** for a description of ``--submit`` and other common +options. ACTIVATE-DISKS ^^^^^^^^^^^^^^ -**activate-disks** [--submit] [--ignore-size] {*instance*} +**activate-disks** [\--submit] [\--ignore-size] [\--wait-for-sync] {*instance*} Activates the block devices of the given instance. If successful, the command will show the location and name of the block devices:: @@ -1284,10 +1330,7 @@ In this example, *node1.example.com* is the name of the node on which the devices have been activated. The *disk/0* and *disk/1* are the Ganeti-names of the instance disks; how they are visible inside the instance is hypervisor-specific. */dev/drbd0* and */dev/drbd1* are the -actual block devices as visible on the node. The ``--submit`` 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**. +actual block devices as visible on the node. The ``--ignore-size`` option can be used to activate disks ignoring the currently configured size in Ganeti. This can be used in cases @@ -1296,13 +1339,23 @@ where the configuration has gotten out of sync with the real-world in LVM devices). This should not be used in normal cases, but only when activate-disks fails without it. +The ``--wait-for-sync`` option will ensure that the command returns only +after the instance's disks are synchronised (mostly for DRBD); this can +be useful to ensure consistency, as otherwise there are no commands that +can wait until synchronisation is done. However when passing this +option, the command will have additional output, making it harder to +parse the disk information. + Note that it is safe to run this command while the instance is already running. +See **ganeti(7)** for a description of ``--submit`` and other common +options. + DEACTIVATE-DISKS ^^^^^^^^^^^^^^^^ -**deactivate-disks** [-f] [--submit] {*instance*} +**deactivate-disks** [-f] [\--submit] {*instance*} De-activates the block devices of the given instance. Note that if you run this command for an instance with a drbd disk template, while it @@ -1317,15 +1370,14 @@ option passed it will skip this check and directly try to deactivate the disks. This can still fail due to the instance actually running or other issues. -The ``--submit`` 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**. +See **ganeti(7)** for a description of ``--submit`` and other common +options. GROW-DISK ^^^^^^^^^ -**grow-disk** [--no-wait-for-sync] [--submit] {*instance*} {*disk*} -{*amount*} +| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--absolute] +| {*instance*} {*disk*} {*amount*} Grows an instance's disk. This is only possible for instances having a plain, drbd or rbd disk template. @@ -1343,10 +1395,15 @@ disk. Usually, you will need to: the partition table on the disk The *disk* argument is the index of the instance disk to grow. The -*amount* argument is given either as a number (and it represents the -amount to increase the disk with in mebibytes) or can be given similar -to the arguments in the create instance operation, with a suffix -denoting the unit. +*amount* argument is given as a number which can have a suffix (like the +disk size in instance create); if the suffix is missing, the value will +be interpreted as mebibytes. + +By default, the *amount* value represents the desired increase in the +disk size (e.g. an amount of 1G will take a disk of size 3G to 4G). If +the optional ``--absolute`` parameter is passed, then the *amount* +argument doesn't represent the delta, but instead the desired final disk +size (e.g. an amount of 8G will take a disk of size 4G to 8G). For instances with a drbd template, note that the disk grow operation might complete on one node but fail on the other; this will leave the @@ -1356,14 +1413,16 @@ create problems (except for unused space). If you do not want gnt-instance to wait for the new disk region to be synced, use the ``--no-wait-for-sync`` option. -The ``--submit`` 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**. +See **ganeti(7)** for a description of ``--submit`` and other common +options. Example (increase the first disk for instance1 by 16GiB):: # gnt-instance grow-disk instance1.example.com 0 16g +Example for increasing the disk size to a certain size:: + + # gnt-instance grow-disk --absolute instance1.example.com 0 32g Also note that disk shrinking is not supported; use **gnt-backup export** and then **gnt-backup import** to reduce the disk size of an @@ -1372,8 +1431,9 @@ instance. RECREATE-DISKS ^^^^^^^^^^^^^^ -| **recreate-disks** [--submit] [-n node1:[node2]] -| [--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*} +| **recreate-disks** [\--submit] +| [{-n node1:[node2] \| {-I\|\--iallocator *name*}}] +| [\--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*} Recreates all or a subset of disks of the given instance. @@ -1398,9 +1458,13 @@ passed must equal the number of nodes that the instance currently has. Note that changing nodes is only allowed when all disks are replaced, e.g. when no ``--disk`` option is passed. -The ``--submit`` 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**. +Another method of chosing which nodes to place the instance on is by +using the specified iallocator, passing the ``--iallocator`` option. +The primary and secondary nodes will be chosen by the specified +iallocator plugin. + +See **ganeti(7)** for a description of ``--submit`` and other common +options. Recovery ~~~~~~~~ @@ -1408,10 +1472,10 @@ Recovery FAILOVER ^^^^^^^^ -| **failover** [-f] [--ignore-consistency] [--ignore-ipolicy] -| [--shutdown-timeout=*N*] -| [{-n|--target-node} *node* \| {-I|--iallocator} *name*] -| [--submit] +| **failover** [-f] [\--ignore-consistency] [\--ignore-ipolicy] +| [\--shutdown-timeout=*N*] +| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] +| [\--submit] | {*instance*} Failover will stop the instance (if running), change its primary node, @@ -1440,13 +1504,12 @@ before forcing the shutdown (xm destroy in xen, killing the kvm process, for kvm). By default two minutes are given to each instance to stop. -The ``--submit`` 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**. - 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-instance failover instance1.example.com @@ -1455,12 +1518,12 @@ Example:: MIGRATE ^^^^^^^ -**migrate** [-f] {--cleanup} {*instance*} +| **migrate** [-f] [\--allow-failover] [\--non-live] +| [\--migration-mode=live\|non-live] [\--ignore-ipolicy] +| [\--no-runtime-changes] [\--submit] +| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*} -**migrate** [-f] [--allow-failover] [--non-live] -[--migration-mode=live\|non-live] [--ignore-ipolicy] -[--no-runtime-changes] -[{-n|--target-node} *node* \| {-I|--iallocator} *name*] {*instance*} +| **migrate** [-f] \--cleanup [\--submit] {*instance*} Migrate will move the instance to its secondary node without shutdown. As with failover, it only works for instances having the drbd disk @@ -1510,6 +1573,12 @@ The ``--no-runtime-changes`` option forbids migrate to alter an instance's runtime before migrating it (eg. ballooning an instance down because the target node doesn't have enough available memory). +If an instance has the backend parameter ``always\_failover`` set to +true, then the migration is automatically converted into a failover. + +See **ganeti(7)** for a description of ``--submit`` and other common +options. + Example (and expected output):: # gnt-instance migrate instance1 @@ -1537,9 +1606,9 @@ Example (and expected output):: MOVE ^^^^ -**move** [-f] [--ignore-consistency] -[-n *node*] [--shutdown-timeout=*N*] [--submit] [--ignore-ipolicy] -{*instance*} +| **move** [-f] [\--ignore-consistency] +| [-n *node*] [\--shutdown-timeout=*N*] [\--submit] [\--ignore-ipolicy] +| {*instance*} Move will move the instance to an arbitrary node in the cluster. This works only for instances having a plain or file disk template. @@ -1557,13 +1626,12 @@ The ``--ignore-consistency`` option will make Ganeti ignore any errors in trying to shutdown the instance on its node; useful if the hypervisor is broken and you want to recuperate the data. -The ``--submit`` 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**. - 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-instance move -n node3.example.com instance1.example.com @@ -1572,7 +1640,8 @@ Example:: CHANGE-GROUP ~~~~~~~~~~~~ -**change-group** [--iallocator *NAME*] [--to *GROUP*...] {*instance*} +| **change-group** [\--submit] +| [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*} This command moves an instance to another node group. The move is calculated by an iallocator, either given on the command line or as a @@ -1581,6 +1650,9 @@ cluster default. If no specific destination groups are specified using ``--to``, all groups except the one containing the instance are considered. +See **ganeti(7)** for a description of ``--submit`` and other common +options. + Example:: # gnt-instance change-group -I hail --to rack2 inst1.example.com @@ -1592,7 +1664,7 @@ TAGS ADD-TAGS ^^^^^^^^ -**add-tags** [--from *file*] {*instancename*} {*tag*...} +**add-tags** [\--from *file*] {*instancename*} {*tag*...} Add tags to the given instance. If any of the tags contains invalid characters, the entire operation will abort. @@ -1613,7 +1685,7 @@ List the tags of the given instance. REMOVE-TAGS ^^^^^^^^^^^ -**remove-tags** [--from *file*] {*instancename*} {*tag*...} +**remove-tags** [\--from *file*] {*instancename*} {*tag*...} Remove tags from the given instance. If any of the tags are not existing on the node, the entire operation will abort.