| {{-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
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
+(e.g. plain KVM with LVM) to being managed via Ganeti. Please note that
this works only for the \`plain' disk template (see below for
template details).
parameters for the instance. If no such parameters are specified, the
values are inherited from the cluster. Possible parameters are:
-memory
- the memory size of the instance; as usual, suffixes can be used to
- denote the unit, otherwise the value is taken in mebibites
+maxmem
+ the maximum memory size of the instance; as usual, suffixes can be
+ used to denote the unit, otherwise the value is taken in mebibytes
+
+minmem
+ the minimum memory size of the instance; as usual, suffixes can be
+ used to denote the unit, otherwise the value is taken in mebibytes
vcpus
the number of VCPUs to assign to the instance (if this value makes
whether the instance is considered in the N+1 cluster checks
(enough redundancy in the cluster to survive a node failure)
+always\_failover
+ ``True`` or ``False``, whether the instance must be failed over
+ (shut down and rebooted) always or it may be migrated (briefly
+ suspended)
+
+Note that before 2.6 Ganeti had a ``memory`` parameter, which was the
+only value of memory an instance could have. With the
+``maxmem``/``minmem`` change Ganeti guarantees that at least the minimum
+memory is always available for an instance, but allows more memory to be
+used (up to the maximum memory) should it be free.
The ``-H (--hypervisor-parameters)`` option specified the hypervisor
to use for the instance (must be one of the enabled hypervisors on the
n
network boot (PXE)
- The default is not to set an HVM boot order which is interpreted
+ The default is not to set an HVM boot order, which is interpreted
as 'dc'.
For KVM the boot order is either "floppy", "cdrom", "disk" or
vnc\_x509\_verify
Valid for the KVM hypervisor.
+spice\_bind
+ Valid for the KVM hypervisor.
+
+ Specifies the address or interface on which the SPICE server will
+ listen. Valid values are:
+
+ - IPv4 addresses, including 0.0.0.0 and 127.0.0.1
+ - IPv6 addresses, including :: and ::1
+ - names of network interfaces
+
+ If a network interface is specified, the SPICE server will be bound
+ to one of the addresses of that interface.
+
+spice\_ip\_version
+ Valid for the KVM hypervisor.
+
+ Specifies which version of the IP protocol should be used by the
+ SPICE server.
+
+ It is mainly intended to be used for specifying what kind of IP
+ addresses should be used if a network interface with both IPv4 and
+ IPv6 addresses is specified via the ``spice_bind`` parameter. In
+ this case, if the ``spice_ip_version`` parameter is not used, the
+ default IP version of the cluster will be used.
+
+spice\_password\_file
+ Valid for the KVM hypervisor.
+
+ Specifies a file containing the password that must be used when
+ connecting via the SPICE protocol. If the option is not specified,
+ passwordless connections are allowed.
+
+spice\_image\_compression
+ Valid for the KVM hypervisor.
+
+ Configures the SPICE lossless image compression. Valid values are:
+
+ - auto_glz
+ - auto_lz
+ - quic
+ - glz
+ - lz
+ - off
+
+spice\_jpeg\_wan\_compression
+ Valid for the KVM hypervisor.
+
+ Configures how SPICE should use the jpeg algorithm for lossy image
+ compression on slow links. Valid values are:
+
+ - auto
+ - never
+ - always
+
+spice\_zlib\_glz\_wan\_compression
+ Valid for the KVM hypervisor.
+
+ Configures how SPICE should use the zlib-glz algorithm for lossy image
+ compression on slow links. Valid values are:
+
+ - auto
+ - never
+ - always
+
+spice\_streaming\_video
+ Valid for the KVM hypervisor.
+
+ Configures how SPICE should detect video streams. Valid values are:
+
+ - off
+ - all
+ - filter
+
+spice\_playback\_compression
+ Valid for the KVM hypervisor.
+
+ Configures whether SPICE should compress audio streams or not.
+
+spice\_use\_tls
+ Valid for the KVM hypervisor.
+
+ Specifies that the SPICE server must use TLS to encrypt all the
+ traffic with the client.
+
+spice\_tls\_ciphers
+ Valid for the KVM hypervisor.
+
+ Specifies a list of comma-separated ciphers that SPICE should use
+ for TLS connections. For the format, see man cipher(1).
+
+spice\_use\_vdagent
+ Valid for the KVM hypervisor.
+
+ Enables or disables passing mouse events via SPICE vdagent.
+
acpi
Valid for the Xen HVM and KVM hypervisors.
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.
+
Example::
- # gnt-instance add -t file --disk 0:size=30g -B memory=512 -o debian-etch \
+ # gnt-instance add -t file --disk 0:size=30g -B maxmem=512 -o debian-etch \
-n node1.example.com --file-storage-dir=mysubdir instance1.example.com
- # gnt-instance add -t plain --disk 0:size=30g -B memory=512 -o debian-etch \
- -n node1.example.com instance1.example.com
+ # gnt-instance add -t plain --disk 0:size=30g -B maxmem=1024,minmem=512 \
+ -o debian-etch -n node1.example.com instance1.example.com
# gnt-instance add -t plain --disk 0:size=30g --disk 1:size=100g,vg=san \
- -B memory=512 -o debian-etch -n node1.example.com instance1.example.com
- # gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
+ -B maxmem=512 -o debian-etch -n node1.example.com instance1.example.com
+ # gnt-instance add -t drbd --disk 0:size=30g -B maxmem=512 -o debian-etch \
-n node1.example.com:node2.example.com instance2.example.com
"iallocator": "dumb",
"hypervisor": "xen-hvm",
"hvparams": {"acpi": true},
- "backend": {"memory": 512}
+ "backend": {"maxmem": 512, "minmem": 256}
}
}
^^^^^^
**remove** [--ignore-failures] [--shutdown-timeout=*N*] [--submit]
-{*instance*}
+[--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
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.
+
Example::
# gnt-instance remove instance1.example.com
| **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]
| {*instance*}
Modifies the memory size, number of vcpus, ip address, MAC address
to the ``drbd`` template in order to make the instance available for
startup before DRBD has finished resyncing.
+The ``-m (--runtime-memory)`` option will change an instance's runtime
+memory to the given size (in MB if a different suffix is not specified),
+by ballooning it up or down to the new value.
+
The ``--disk add:size=``*SIZE* option adds a disk to the instance. The
optional ``vg=``*VG* option specifies LVM volume group other than
default vg to create the disk on. For DRBD disks, the ``metavg=``*VG*
``--force-variant`` is passed. An invalid OS will also be refused,
unless the ``--force`` option is given.
+The ``--online`` and ``--offline`` options are used to transition an
+instance into and out of the ``offline`` state. An instance can be
+turned offline only if it was previously down. The ``--online`` option
+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**.
-All the changes take effect at the next restart. If the instance is
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
+
+Most of the changes take effect at the next restart. If the instance is
running, there is no effect on the instance.
REINSTALL
forth, e.g.::
# gnt-instance start -H kernel_args="single" instance1
- # gnt-instance start -B memory=2048 instance2
+ # gnt-instance start -B maxmem=2048 instance2
The first form will start the instance instance1 in single-user mode,
REPLACE-DISKS
^^^^^^^^^^^^^
-**replace-disks** [--submit] [--early-release] {-p} [--disks *idx*]
-{*instance*}
+**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-p}
+[--disks *idx*] {*instance*}
-**replace-disks** [--submit] [--early-release] {-s} [--disks *idx*]
-{*instance*}
+**replace-disks** [--submit] [--early-release] [--ignore-ipolicy] {-s}
+[--disks *idx*] {*instance*}
-**replace-disks** [--submit] [--early-release] {--iallocator *name*
-\| --new-secondary *NODE*} {*instance*}
+**replace-disks** [--submit] [--early-release] [--ignore-ipolicy]
+{--iallocator *name* \| -- {*instance*}
-**replace-disks** [--submit] [--early-release] {--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.
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).
+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.
RECREATE-DISKS
^^^^^^^^^^^^^^
-**recreate-disks** [--submit] [--disks=``indices``] [-n node1:[node2]]
- {*instance*}
+| **recreate-disks** [--submit] [-n node1:[node2]]
+| [--disk=*N*[:[size=*VAL*][,mode=*ro\|rw*]]] {*instance*}
-Recreates the disks of the given instance, or only a subset of the
-disks (if the option ``disks`` is passed, which must be a
-comma-separated list of disk indices, starting from zero).
+Recreates all or a subset of disks of the given instance.
Note that this functionality should only be used for missing disks; if
any of the given disks already exists, the operation will fail. While
this is suboptimal, recreate-disks should hopefully not be needed in
normal operation and as such the impact of this is low.
+If only a subset should be recreated, any number of ``disk`` options can
+be specified. It expects a disk index and an optional list of disk
+parameters to change. Only ``size`` and ``mode`` can be changed while
+recreating disks. To recreate all disks while changing parameters on
+a subset only, a ``--disk`` option must be given for every disk of the
+instance.
+
Optionally the instance's disks can be recreated on different
nodes. This can be useful if, for example, the original nodes of the
instance have gone down (and are marked offline), so we can't recreate
on the same nodes. To do this, pass the new node(s) via ``-n`` option,
with a syntax similar to the **add** command. The number of nodes
passed must equal the number of nodes that the instance currently
-has. Note that changing nodes is only allowed for 'all disk'
-replacement (when ``--disks`` is not passed).
+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
^^^^^^^^
**failover** [-f] [--ignore-consistency] [--shutdown-timeout=*N*]
-[--submit] {*instance*}
+[--submit] [--ignore-ipolicy] {*instance*}
-Failover will fail the instance over its secondary node. This works
-only for instances having a drbd disk template.
+Failover will stop the instance (if running), change its primary node,
+and if it was originally running it will start it again (on the new
+primary). This only works for instances with drbd template (in which
+case you can only fail to the secondary node) and for externally
+mirrored templates (shared storage) (which can change to any other
+node).
Normally the failover will check the consistency of the disks before
failing over the instance. If you are trying to migrate instances off
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.
+
Example::
# gnt-instance failover instance1.example.com
**migrate** [-f] {--cleanup} {*instance*}
**migrate** [-f] [--allow-failover] [--non-live]
-[--migration-mode=live\|non-live] {*instance*}
+[--migration-mode=live\|non-live] [--ignore-ipolicy] {*instance*}
Migrate will move the instance to its secondary node without
shutdown. It only works for instances having the drbd8 disk template
The option ``-f`` will skip the prompting for confirmation.
If ``--allow-failover`` is specified it tries to fallback to failover if
-it already can determine that a migration wont work (i.e. if the
-instance is shutdown). Please note that the fallback will not happen
+it already can determine that a migration won't work (e.g. if the
+instance is shut down). Please note that the fallback will not happen
during execution. If a migration fails during execution it still fails.
+If ``--ignore-ipolicy`` is given any instance policy violations occuring
+during this operation are ignored.
+
Example (and expected output)::
# gnt-instance migrate instance1
- Migrate will happen to the instance instance1. Note that migration is
- **experimental** in this version. This might impact the instance if
- anything goes wrong. Continue?
+ Instance instance1 will be migrated. Note that migration
+ might impact the instance if anything goes wrong (e.g. due to bugs in
+ the hypervisor). Continue?
y/[n]/?: y
+ Migrating instance instance1.example.com
* checking disk consistency between source and target
- * ensuring the target is in secondary mode
+ * switching node node2.example.com to secondary mode
+ * changing into standalone mode
* changing disks into dual-master mode
- - INFO: Waiting for instance instance1 to sync disks.
- - INFO: Instance instance1's disks are in sync.
+ * wait until resync is done
+ * preparing node2.example.com to accept the instance
* migrating instance to node2.example.com
- * changing the instance's disks on source node to secondary
- - INFO: Waiting for instance instance1 to sync disks.
- - INFO: Instance instance1's disks are in sync.
- * changing the instance's disks to single-master
+ * switching node node1.example.com to secondary mode
+ * wait until resync is done
+ * changing into standalone mode
+ * changing disks into single-master mode
+ * wait until resync is done
+ * done
#
^^^^
**move** [-f] [--ignore-consistency]
-[-n *node*] [--shutdown-timeout=*N*] [--submit]
+[-n *node*] [--shutdown-timeout=*N*] [--submit] [--ignore-ipolicy]
{*instance*}
Move will move the instance to an arbitrary node in the cluster. This
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.
+
Example::
# gnt-instance move -n node3.example.com instance1.example.com
+CHANGE-GROUP
+~~~~~~~~~~~~
+
+**change-group** [--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
+cluster default.
+
+If no specific destination groups are specified using ``--to``, all
+groups except the one containing the instance are considered.
+
+Example::
+
+ # gnt-instance change-group -I hail --to rack2 inst1.example.com
+
+
TAGS
~~~~
projects / ganeti-local / blobdiff