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.
-If you don't wat the instance to automatically start after
+If you don't want the instance to automatically start after
creation, this is possible via the ``--no-start`` option. This will
leave the instance down until a subsequent **gnt-instance start**
command.
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.
This parameter determines the way the cdroms disks are presented
to the instance. The default behavior is to get the same value of
- the eariler parameter (disk_type). The possible options are:
+ the earlier parameter (disk_type). The possible options are:
- paravirtual
- ide
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.
use\_chroot
Valid for the KVM hypervisor.
- This boolean option determines wether to run the KVM instance in a
+ This boolean option determines whether to run the KVM instance in a
chroot directory.
If it is set to ``true``, an empty directory is created before
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.
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 \
mac, ip, mode, link
Specifications for the one NIC that will be created for the
- instance. 'bridge' is also accepted as a backwards compatibile
+ instance. 'bridge' is also accepted as a backwards compatible
key.
nics
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
| [{-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 \|
+| [\--net add*[:options]* \| \--net [*N*:]remove \| \--net *N:options*]
+| [\--disk add:size=*SIZE*[,vg=*VG*][,metavg=*VG*] \| \--disk [*N*:]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]]
``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``).
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.
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
^^^^^^
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``--no-remember`` option will perform the startup but not change
the state of the instance in the configuration file (if it was stopped
-before, Ganeti will still thinks it needs to be stopped). This can be
+before, Ganeti will still think it needs to be stopped). This can be
used for testing, or for a one shot-start where you don't want the
watcher to restart the instance if it crashes.
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
``--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.
``--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
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
[\--disks *idx*] {*instance*}
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
-{\--iallocator *name* \| \--node *node* } {*instance*}
+{{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
**replace-disks** [\--submit] [\--early-release] [\--ignore-ipolicy]
-{\--auto} {*instance*}
+{-a\|\--auto} {*instance*}
This command is a generalized form for replacing disks. It is
currently only valid for the mirrored (DRBD) disk template.
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)
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
^^^^^^^^^^^^^^
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
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
^^^^^^^^^^^^^^^^
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.
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
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
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**.
+See **ganeti(7)** for a description of ``--submit`` and other common
+options.
Recovery
~~~~~~~~
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
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
If the ``--cleanup`` option is passed, the operation changes from
migration to attempting recovery from a failed previous migration. In
this mode, Ganeti checks if the instance runs on the correct node (and
-updates its configuration if not) and ensures the instances's disks
+updates its configuration if not) and ensures the instances' disks
are configured correctly. In this mode, the ``--non-live`` option is
ignored.
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
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.
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
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
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
projects / ganeti-local / blobdiff