X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/86b8c6ae95241f5e79d553120ff6476984bc8850..1b54fc6c2fd92b614c029cc5312d02f9f1526253:/man/gnt-instance.sgml
diff --git a/man/gnt-instance.sgml b/man/gnt-instance.sgml
index 597d8c3..2d9d44f 100644
--- a/man/gnt-instance.sgml
+++ b/man/gnt-instance.sgml
@@ -2,7 +2,7 @@
- May 16, 2007">
+ February 11, 2009">
8">
@@ -20,6 +20,8 @@
20062007
+ 2008
+ 2009Google Inc.
&dhdate;
@@ -28,7 +30,7 @@
&dhucpackage;
&dhsection;
- ganeti 1.2
+ ganeti 2.0&dhpackage;
@@ -62,53 +64,125 @@
ADDadd
- -s disksize
- --swap-size disksize
- -m memsize
- -o os-type
- -b bridge
-
- -t
+ -tdiskless
+ fileplain
- local_raid1
- remote_raid1
-
-
+ drbd
+
+
+
+
+ --disk=N:size=VAL,mode=ro|rw
+ -s SIZE
+
+
+
+ --net=N:options
+ --no-nics
+
+
+ -B BEPARAMS
+
+
+ -H HYPERVISOR:option=value
+
+
+ --file-storage-dir dir_path
+ --file-driver
+ loop
+ blktap
+
+
+
+
+ -n node:secondary-node
+ --iallocator name
+
+
+
+ -o os-type
+
+ --submit
- -n node
+
instance
+
- Creates a new instance on the specified
- host. instance must be in DNS and
- resolve to a IP in the same network as the nodes in the
- cluster.
+ Creates a new instance on the specified host. The
+ instance argument must be in DNS,
+ but depending on the bridge setup, need not be in the same
+ network as the nodes in the cluster.
- The option specifies the disk size for
- the instance, in mebibytes (defaults to
- 20480MiB =
- 20GiB). You can also use one of the
- suffixes m, g or
+ 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
+ m, g or
t to specificy the exact the units used;
these suffixes map to mebibytes, gibibytes and tebibytes.
- The option specifies the swap
- disk size (in mebibytes) for the instance (the one presented
- as /dev/sdb). The
- default is 4096MiB. As for the disk
- size, you can specify other suffixes.
+ 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
+ version (but will only create one disk).
- The option specifies the memory size for
- the instance, in mebibytes (defaults to 128 MiB). Again, you
- can use other suffixes (e.g. 2g).
+ The minimum disk specification is therefore
+ --disk 0:size=20G (or -s
+ 20G when using the option),
+ and a three-disk instance can be specified as
+ --disk 0:size=20G --disk 1:size=4G --disk
+ 2:size=100G.
+
+
+
+ The NICs of the instances can be specified via the
+ option. By default, one NIC is
+ created for the instance, with a random MAC, and connected
+ to the default bridge. Each NIC can take up to three
+ parameters (all optional):
+
+
+ mac
+
+ either a value or GENERATE
+ to generate a new unique MAC
+
+
+
+ ip
+
+ specifies the IP address assigned to the
+ instance from the Ganeti side (this is not necessarily
+ what the instance will use, but what the node expects
+ the instance to use)
+
+
+
+ bridge
+
+ specifies the bridge to attach this NIC
+ to
+
+
+
+
+
+
+ Alternatively, if no network is desired for the instance, you
+ can prevent the default of one NIC with the
+ option.
@@ -118,9 +192,318 @@
- The option specifies the bridge to which the
- instance will be connected. (defaults to the cluster-wide default
- bridge specified at cluster initialization time).
+ The option specifies the backend
+ 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
+
+
+
+ vcpus
+
+ the number of VCPUs to assign to the instance
+ (if this value makes sense for the hypervisor)
+
+
+
+ auto_balance
+
+ whether the instance is considered in the N+1
+ cluster checks (enough redundancy in the cluster to
+ survive a node failure)
+
+
+
+
+
+
+ The option specified the hypervisor to
+ use for the instance (must be one of the enabled hypervisors
+ on the cluster) and optionally custom parameters for this
+ instance. If not other options are used (i.e. the invocation
+ is just -H
+ NAME) the instance
+ will inherit the cluster options. The defaults below show
+ the cluster defaults at cluster creation time.
+
+
+
+ The possible hypervisor options are as follows:
+
+
+ boot_order
+
+ Valid for the Xen HVM and KVM
+ hypervisors.
+
+ A string value denoting the boot order. This
+ has different meaning for the Xen HVM hypervisor and
+ for the KVM one.
+
+
+ For Xen HVM, The boot order is a string of letters
+ listing the boot devices, with valid device letters
+ being:
+
+
+
+ a
+
+
+ floppy drive
+
+
+
+
+ c
+
+
+ hard disk
+
+
+
+
+ d
+
+
+ CDROM drive
+
+
+
+
+ n
+
+
+ network boot (PXE)
+
+
+
+
+
+ The default is not to set an HVM boot order which is
+ interpreted as 'dc'.
+
+
+
+
+
+ cdrom_image_path
+
+ Valid for the Xen HVM and KVM hypervisors.
+
+ The path to a CDROM image to attach to the
+ instance.
+
+
+
+
+ nic_type
+
+ Valid for the Xen HVM and KVM hypervisors.
+
+
+ This parameter determines the way the network cards
+ are presented to the instance. The possible options are:
+
+ rtl8139 (default for Xen HVM) (HVM & KVM)
+ ne2k_isa (HVM & KVM)
+ ne2k_pci (HVM & KVM)
+ i82551 (KVM)
+ i82557b (KVM)
+ i82559er (KVM)
+ pcnet (KVM)
+ e1000 (KVM)
+ paravirtual (default for KVM) (HVM & KVM)
+
+
+
+
+
+ disk_type
+
+ Valid for the Xen HVM and KVM hypervisors.
+
+
+ This parameter determines the way the disks are
+ presented to the instance. The possible options are:
+
+ ioemu (default for HVM & KVM) (HVM & KVM)
+ ide (HVM & KVM)
+ scsi (KVM)
+ sd (KVM)
+ mtd (KVM)
+ pflash (KVM)
+
+
+
+
+
+ vnc_bind_address
+
+ Valid for the Xen HVM and KVM hypervisors.
+
+ Specifies the address that the VNC listener for
+ this instance should bind to. Valid values are IPv4
+ addresses. Use the address 0.0.0.0 to bind to all
+ available interfaces (this is the default) or specify
+ the address of one of the interfaces on the node to
+ restrict listening to that interface.
+
+
+
+
+ vnc_tls
+
+ Valid for the KVM hypervisor.
+
+ A boolean option that controls whether the
+ VNC connection is secured with TLS.
+
+
+
+
+ vnc_x509_path
+
+ Valid for the KVM hypervisor.
+
+ If is enabled, this
+ options specifies the path to the x509 certificate to
+ use.
+
+
+
+
+ vnc_x509_verify
+
+ Valid for the KVM hypervisor.
+
+
+
+
+ acpi
+
+ Valid for the Xen HVM and KVM hypervisors.
+
+
+ A boolean option that specifies if the hypervisor
+ should enable ACPI support for this instance. By
+ default, ACPI is disabled.
+
+
+
+
+
+ pae
+
+ Valid for the Xen HVM and KVM hypervisors.
+
+
+ A boolean option that specifies if the hypervisor
+ should enabled PAE support for this instance. The
+ default is false, disabling PAE support.
+
+
+
+
+
+ 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.
+
+
+
+
+
+ kernel_args
+
+ Valid for the Xen PVM and KVM hypervisors.
+
+
+ This options specifies extra arguments to the kernel
+ that will be loaded. device. This is always used
+ for Xen PVM, while for KVM it is only used if the
+ option is also
+ specified.
+
+
+
+ The default setting for this value is simply
+ "ro", which mounts the root
+ disk (initially) in read-only one. For example,
+ setting this to single will
+ cause the instance to start in single-user mode.
+
+
+
+
+
+ initrd_path
+
+ Valid for the Xen PVM and KVM hypervisors.
+
+
+ This option specifies the path (on the node) to the
+ initrd to boot the instance with. Xen PVM instances
+ can use this always, while for KVM if this option is
+ only used if the option
+ is also specified. You can pass here either an
+ absolute filename (the path to the initrd) if you
+ want to use an initrd, or use the format
+ no_initrd_path for no initrd.
+
+
+
+
+
+ root_path
+
+ Valid for the Xen PVM and KVM hypervisors.
+
+
+ This options specifies the name of the root
+ device. This is always needed for Xen PVM, while for
+ KVM it is only used if the
+ option is also
+ specified.
+
+
+
+
+
+ serial_console
+
+ Valid for the KVM hypervisor.
+
+ This boolean option specifies whether to
+ emulate a serial console for the instance.
+
+
+
+
+
+
+
+
+
+ The option specifies the instance
+ allocator plugin to use. If you pass in this option the allocator
+ will select nodes for this instance automatically, so you don't need
+ to pass them with the option. For more
+ information please refer to the instance allocator documentation.
@@ -137,28 +520,23 @@
- plain
+ file
- Disk devices will be logical volumes.
+ Disk devices will be regular files.
- local_raid1
+ plain
-
- Disk devices will be md raid1 arrays over two local
- logical volumes.
-
+ Disk devices will be logical volumes.
- remote_raid1
+ drbd
- Disk devices will be md raid1 arrays with one
- component (so it's not actually raid1): a drbd device
- between the instance's primary node and the node given
- by the option .
+ Disk devices will be drbd (version 8.x) on top of
+ lvm volumes.
@@ -166,9 +544,8 @@
- The option is used with
- the remote raid disk template type and specifies the remote
- node.
+ The optional second value of the is used for
+ the drbd template type and specifies the remote node.
@@ -177,17 +554,205 @@
option.
+
+ The specifies the relative path
+ under the cluster-wide file storage directory to store file-based
+ disks. It is useful for having different subdirectories for
+ different instances. The full path of the directory where the disk
+ files are stored will consist of cluster-wide file storage directory
+ + optional subdirectory + instance name. Example:
+ /srv/ganeti/file-storage/mysubdir/instance1.example.com. This option
+ is only relevant for instances using the file storage backend.
+
+
+
+ The specifies the driver to use for
+ file-based disks. Note that currently these drivers work with the
+ xen hypervisor only. This option is only relevant for instances using
+ the file storage backend. The available choices are:
+
+
+ loop
+
+
+ Kernel loopback driver. This driver uses loopback
+ devices to access the filesystem within the
+ file. However, running I/O intensive applications in
+ your instance using the loop driver might result in
+ slowdowns. Furthermore, if you use the loopback
+ driver consider increasing the maximum amount of
+ loopback devices (on most systems it's 8) using the
+ max_loop param.
+
+
+
+
+ blktap
+
+ The blktap driver (for Xen hypervisors). In
+ order to be able to use the blktap driver you should
+ check if the 'blktapctrl' user space disk agent is
+ running (usually automatically started via xend). This
+ user-level disk I/O interface has the advantage of
+ better performance. Especially if you use a network
+ file system (e.g. NFS) to store your instances this is
+ the recommended choice.
+
+
+
+
+
+
+
+ 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.
+
Example:
-# gnt-instance add -t plain -s 30g -m 512 -o debian-etch \
+# gnt-instance add -t file --disk 0:size=30g -B memory=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 remote_raid1 --secondary-node node3.example.com \
- -s 30g -m 512 -o debian-etch \
- -n node1.example.com instance2.example.com
+# gnt-instance add -t drbd --disk 0:size=30g -B memory=512 -o debian-etch \
+ -n node1.example.com:node2.example.com instance2.example.com
+
+
+
+ BATCH-CREATE
+
+ batch-create
+ instances_file.json
+
+
+
+ This command (similar to the Ganeti 1.2
+ batcher tool) submits multiple instance
+ creation jobs based on a definition file. The instance
+ configurations do not encompass all the possible options for
+ the add command, but only a subset.
+
+
+
+ The instance file should be a valid-formed JSON file,
+ containing a dictionary with instance name and instance
+ parameters. The accepted parameters are:
+
+
+
+ disk_size
+
+ The size of the disks of the instance.
+
+
+
+ disk_templace
+
+ The disk template to use for the instance,
+ the same as in the add
+ command.
+
+
+
+ backend
+
+ A dictionary of backend parameters.
+
+
+
+ hypervisor
+
+ A dictionary with a single key (the
+ hypervisor name), and as value the hypervisor
+ options. If not passed, the default hypervisor and
+ hypervisor options will be inherited.
+
+
+
+ mac, ip, bridge
+
+ Specifications for the one NIC that will be
+ created for the instance.
+
+
+
+ primary_node, secondary_node
+
+ The primary and optionally the secondary node
+ to use for the instance (in case an iallocator script
+ is not used).
+
+
+
+ iallocator
+
+ Instead of specifying the nodes, an
+ iallocator script can be used to automatically compute
+ them.
+
+
+
+ start
+
+ whether to start the instance
+
+
+
+ ip_check
+
+ Skip the check for already-in-use instance;
+ see the description in the add
+ command for details.
+
+
+
+ file_storage_dir, file_driver
+
+ Configuration for the file
+ disk type, see the add command for
+ details.
+
+
+
+
+
+
+ A simple definition for one instance can be (with most of
+ the parameters taken from the cluster defaults):
+
+{
+ "instance3": {
+ "template": "drbd",
+ "os": "debootstrap",
+ "disk_size": ["25G"],
+ "iallocator": "dumb"
+ },
+ "instance5": {
+ "template": "drbd",
+ "os": "debootstrap",
+ "disk_size": ["25G"],
+ "iallocator": "dumb",
+ "hypervisor": "xen-hvm",
+ "hvparams": {"acpi": true},
+ "backend": {"memory": 512}
+ }
+}
+
+
+
+
+ The command will display the job id for each submitted instance, as follows:
+
+# gnt-instance batch-create instances.json
+instance3: 11224
+instance5: 11225
+
+
@@ -197,6 +762,7 @@
remove--ignore-failures
+ --submitinstance
@@ -218,6 +784,13 @@
+ 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.
+
+
+
Example:
# gnt-instance remove instance1.example.com
@@ -232,14 +805,14 @@
list--no-headers--separator=SEPARATOR
- -o FIELD,...
+ -o [+]FIELD,...
+ instance
Shows the currently configured instances with memory usage,
- disk usage, the node they are running on, and the CPU time,
- counted in seconds, used by each instance since its latest
- restart.
+ disk usage, the node they are running on, and their run
+ status.
@@ -255,93 +828,272 @@
are:
- name
+ name
+
+ the instance name
+
+
+
+ os
+
+ the OS of the instance
+
+
+
+ pnode
+
+ the primary node of the instance
+
+
+
+ snodes
+
+ comma-separated list of secondary nodes for the
+ instance; usually this will be just one node
+
+
+
+ admin_state
+
+ the desired state of the instance (either "yes"
+ or "no" denoting the instance should run or
+ not)
+
+
+
+ disk_template
+
+ the disk template of the instance
+
+
+
+ oper_state
+
+ the actual state of the instance; can be
+ one of the values "running", "stopped", "(node
+ down)"
+
+
+
+ status
+
+ combined form of admin_state and oper_stat;
+ this can be one of:
+ ERROR_nodedown if the
+ node of the instance is down,
+ ERROR_down if the
+ instance should run but is down,
+ ERROR_up if the
+ instance should be stopped but is actually running,
+ ADMIN_down if the
+ instance has been stopped (and is stopped) and
+ running if the
+ instance is set to be running (and is
+ running)
+
+
+
+ oper_ram
+
+ the actual memory usage of the instance as seen
+ by the hypervisor
+
+
+
+ ip
+
+ the ip address ganeti recognizes as associated with
+ the first instance interface
+
+
+
+ mac
+
+ the first instance interface MAC address
+
+
+
+ bridge
+
+ the bridge of the first instance NIC
+
+
+
+
+ sda_size
+
+ the size of the instance's first disk
+
+
+
+ sdb_size
+
+ the size of the instance's second disk, if
+ any
+
+
+
+ vcpus
+
+ the number of VCPUs allocated to the
+ instance
+
+
+
+ tags
+
+ comma-separated list of the instances's
+ tags
+
+
+
+ serial_no
+
+ the so called 'serial number' of the
+ instance; this is a numeric field that is incremented
+ each time the instance is modified, and it can be used
+ to track modifications
+
+
+
+ network_port
+
+ If the instance has a network port assigned
+ to it (e.g. for VNC connections), this will be shown,
+ otherwise - will be
+ displayed.
+
+
+
+ beparams
+
+ A text format of the entire beparams for the
+ instance. It's more useful to select individual fields
+ from this dictionary, see below.
+
+
+
+ disk.count
+
+ The number of instance disks.
+
+
+
+ disk.size/N
- the instance name
+ The size of the instance's Nth disk. This is
+ a more generic form of the sda_size
+ and sdb_size fields.
- os
+ disk.sizes
- the OS of the instance
+ A comma-separated list of the disk sizes for
+ this instance.
- pnode
+ disk_usage
- the primary node of the instance
+ The total disk space used by this instance on
+ each of its nodes. This is not the instance-visible
+ disk size, but the actual disk "cost" of the
+ instance.
- snodes
+ nic.mac/N
- comma-separated list of secondary-nodes for the
- instance; usually this will be just one node
+ The MAC of the Nth instance NIC.
- admin_state
+ nic.ip/N
- the desired state of the instance (either "yes"
- or "no" denoting the instance should run or
- not)
+ The IP address of the Nth instance NIC.
- admin_ram
+ nic.bridge/N
- the desired memory for the instance
+ The bridge the Nth instance NIC is attached
+ to.
- disk_template
+ nic.macs
- the disk template of the instance
+ A comma-separated list of all the MACs of the
+ instance's NICs.
- oper_state
+ nic.ips
- the actual state of the instance; can take of
- the values "running", "stopped", "(node down)"
+ A comma-separated list of all the IP
+ addresses of the instance's NICs.
- oper_ram
+ nic.bridges
- the actual memory usage of the instance as seen
- by the hypervisor
+ A comma-separated list of all the bridges of the
+ instance's NICs.
- ip
+ nic.count
- the ip address ganeti recognizes as associated with
- the instance interface
+ The number of instance nics.
- mac
+ hv/NAME
- the instance interface MAC address
+ The value of the hypervisor parameter called
+ NAME. For details of what
+ hypervisor parameters exist and their meaning, see the
+ add command.
- bridge
+ be/memory
- bridge the instance is connected to
-
+ The configured memory for the instance.
+
+
+
+ be/vcpus
+
+ The configured number of VCPUs for the
+ instance.
+
+
+
+ be/auto_balance
+
+ Whether the instance is considered in N+1
+ checks.
+ If the value of the option starts with the character
+ +, the new field(s) will be added to the
+ default list. This allows to quickly see the default list
+ plus a few other fields, instead of retyping the entire list
+ of fields.
+
+
+
There is a subtle grouping about the available output
- fields: all fields except for
- and are configuration value and
- not run-time values. So if you don't select any of the
- fields, the query will be satisfied
+ fields: all fields except for ,
+ and are
+ configuration value and not run-time values. So if you don't
+ select any of the these fields, the query will be satisfied
instantly from the cluster configuration, without having to
ask the remote nodes for the data. This can be helpful for
big clusters when you only want some data and it makes sense
@@ -365,14 +1117,32 @@
info
- instance
+
+ -s
+ --static
+
+
+ --all
+ instance
+
- Show detailed information about the (given) instances. This
- is different from list as it shows
- detailed data about the instance's disks (especially useful
- for remote raid templates).
+ Show detailed information about the given instance(s). This is
+ different from list as it shows detailed data
+ about the instance's disks (especially useful for the drbd disk
+ template).
+
+
+
+ If the option is used, only information
+ available in the configuration file is returned, without
+ querying nodes, making the operation faster.
+
+
+
+ Use the to get info about all instances,
+ rather than explicitely passing the ones you're interested in.
@@ -381,22 +1151,70 @@
modify
- -m memsize
- -p vcpus
- -i ip
- -b bridge
+
+ -H HYPERVISOR_PARAMETERS
+
+ -B BACKEND_PARAMETERS
+
+
+ --net add:options
+ --net remove
+ --net N:options
+
+
+
+ --disk add:size=SIZE
+ --disk remove
+ --disk N:mode=MODE
+
+
+
+ --submit
+ instance
- Modify the memory size, number of vcpus, ip address and/or bridge
- for an instance.
+ Modifies the memory size, number of vcpus, ip address, MAC
+ address and/or bridge for an instance. It can also add and
+ remove disks and NICs to/from the instance. Note that you
+ need to give at least one of the arguments, otherwise the
+ command complains.
+
+
+
+ The option specifies hypervisor options
+ in the form of name=value[,...]. For details which options can be specified, see the add command.
+
+
+
+ The option
+ adds a disk to the instance. The will remove the last disk of the
+ instance. The
+ option will change the mode of the Nth disk of the instance
+ between read-only (ro) and read-write
+ (rw).
- The memory size is given in MiB. Note that you need to give
- at least one of the arguments, otherwise the command
- complains.
+ The option will
+ add a new NIC to the instance. The available options are the
+ same as in the add command (mac, ip,
+ bridge). The will remove the
+ last NIC of the instance, while the
+ option will change the parameters of the Nth instance NIC.
+
+
+
+ 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.
@@ -411,16 +1229,55 @@
reinstall-o os-type
+ --select-os-f force
- instance
+ --force-multiple
+
+
+ --instance
+ --node
+ --primary
+ --secondary
+ --all
+
+ --submit
+ instance
- Reinstalls the operating system on the given instance. The instance
- must be stopped when running this command. If the
- is specified, the operating system is
- changed.
+ Reinstalls the operating system on the given instance(s). The
+ instance(s) must be stopped when running this command. If the
+ is specified, the operating
+ system is changed.
+
+
+
+ The option switches to an
+ interactive OS reinstall. The user is prompted to select the OS
+ template from the list of available OS templates.
+
+
+
+ Since this is a potentially dangerous command, the user will
+ be required to confirm this action, unless the
+ flag is passed. When multiple instances
+ are selected (either by passing multiple arguments or by
+ using the ,
+ , or
+ options), the user must pass both the
+ and
+ options to skip the
+ interactive confirmation.
+
+
+
+ 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.
+
+
@@ -429,6 +1286,7 @@
rename--no-ip-check
+ --submitinstancenew_name
@@ -442,6 +1300,14 @@
instance is started). The IP test can be skipped if the
option is passed.
+
+
+ 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.
+
+
@@ -454,7 +1320,10 @@
startup
- --extra=PARAMS
+
+ --force
+
+ --force-multiple--instance
@@ -464,13 +1333,18 @@
--all
+ -H
+ -B
+
+ --submit
+ name
- Starts one or more instances, depending on the
- mode. The four available modes are:
+ Starts one or more instances, depending on the following
+ options. The four available modes are:
@@ -514,28 +1388,52 @@
- Note that although you can pass more than one
- option, the last one wins, so in
- order to guarantee the desired result, don't pass more than
- one such option.
+ Note that although you can pass more than one selection
+ option, the last one wins, so in order to guarantee the
+ desired result, don't pass more than one such option.
+
+
+
+ Use to start even if secondary disks are
+ failing.
+
+
+
+ The will skip the
+ interactive confirmation in the case the more than one
+ instance will be affected.
- The option is used to pass
- additional argument to the instance's kernel for this start
- only. Currently there is no way to specify a persistent set
- of arguments (beside the one hardcoded). Note that this may
- not apply to all virtualization types.
+ The and options
+ specify extra, temporary hypervisor and backend parameters
+ that can be used to start an instance with modified
+ parameters. They can be useful for quick testing without
+ having to modify an instance back and forth, e.g.:
+
+# gnt-instance start -H root_args="single" instance1
+# gnt-instance start -B memory=2048 instance2
+
+ The first form will start the instance
+ instance1 in single-user mode, and
+ the instance instance2 with 2GB of
+ RAM (this time only, unless that is the actual instance
+ memory size already).
+
+ 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.
+
Example:
# gnt-instance start instance1.example.com
-# gnt-instance start --extra single test1.example.com
-# gnt-instance start --by-node node1.example.com node2.example.com
-# gnt-instance start --by-cluster
+# gnt-instance start --node node1.example.com node2.example.com
+# gnt-instance start --all
@@ -546,6 +1444,8 @@
shutdown
+ --force-multiple
+ --instance--node
@@ -554,7 +1454,8 @@
--all
-
+ --submit
+ name
@@ -575,10 +1476,83 @@
+ 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.
+
+
+
+
Example:
# gnt-instance shutdown instance1.example.com
-# gnt-instance shutdown --by-cluster
+# gnt-instance shutdown --all
+
+
+
+
+
+ REBOOT
+
+
+ reboot
+
+ --type=REBOOT-TYPE
+
+ --ignore-secondaries
+
+ --force-multiple
+
+
+ --instance
+ --node
+ --primary
+ --secondary
+ --all
+
+
+ --submit
+
+ name
+
+
+
+ Reboots one or more instances. The type of reboot depends on
+ the value of . A soft reboot does a
+ hypervisor reboot, a hard reboot does a instance stop,
+ recreates the hypervisor config for the instance and
+ starts the instance. A full reboot does the equivalent
+ of gnt-instance shutdown && gnt-instance
+ startup. The default is hard reboot.
+
+
+
+ For the hard reboot the option
+ ignores errors for the
+ secondary node while re-assembling the instance disks.
+
+
+
+ The , ,
+ , and
+ options are similar as for the
+ startup command and they influence the
+ actual instances being rebooted.
+
+
+
+ The will skip the
+ interactive confirmation in the case the more than one
+ instance will be affected.
+
+
+
+ Example:
+
+# gnt-instance reboot instance1.example.com
+# gnt-instance reboot --type=full instance1.example.com
@@ -587,12 +1561,23 @@
CONSOLEconsole
+ --show-cmdinstance
- Connects to the console of the given instance. If the instance
- is not up, an error is returned.
+ Connects to the console of the given instance. If the
+ instance is not up, an error is returned. Use the
+ option to display the command
+ instead of executing it.
+
+
+
+ For HVM instances, this will attempt to connect to the
+ serial console of the instance. To connect to the
+ virtualized "physical" console of a HVM instance, use a VNC
+ client with the connection info from the
+ info command.
@@ -613,70 +1598,81 @@
replace-disks
- --new-secondary NODE
+ --submit
+ -p
+ --disks idxinstance
-
- This command does a full add and replace for both disks of
- an instance. It basically does an
- addmirror and
- removemirror for both disks of the
- instance.
-
-
-
- If you also want to replace the secondary node during this
- process (for example to fix a broken secondary node), you
- can do so using the option.
-
-
+
+ replace-disks
+ --submit
+ -s
+ --disks idx
+ instance
+
-
- ADD-MIRROR
- add-mirror
- -b sdX
- -n node
+ replace-disks
+ --submit
+
+ --iallocator name
+ --new-secondary NODE
+
+
instance
+
- Adds a new mirror to the disk layout of the instance, if the
- instance has a remote raid disk layout.
+ This command is a generalized form for replacing disks. It
+ is currently only valid for the mirrored (DRBD) disk
+ template.
+
- The new mirror member will be between the instance's primary
- node and the node given with the option.
+
+ The first form (when passing the option)
+ will replace the disks on the primary, while the second form
+ (when passing the option will replace
+ the disks on the secondary node. For these two cases (as the
+ node doesn't change), it is possible to only run the replace
+ for a subset of the disks, using the option
+ which takes a list of
+ comma-delimited disk indices (zero-based),
+ e.g. 0,2 to replace only the first
+ and third disks.
-
-
- REMOVE-MIRROR
+
+ The third form (when passing either the
+ or the
+ option) is designed to
+ change secondary node of the instance. Specifying
+ makes the new secondary be
+ selected automatically by the specified allocator plugin,
+ otherwise the new secondary node will be the one chosen
+ manually via the option.
+
-
- removemirror
- -b sdX
- -p id
- instance
-
- Removes a mirror componenent from the disk layout of the
- instance, if the instance has a remote raid disk layout.
+ 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.
- You need to specifiy on which disk to act on using the
- option (either sda
- or sdb) and the mirror component, which
- is identified by the option. You can
- find the list of valid identifiers with the
- info command.
+ Note that it is not possible to select an offline or drained
+ node as a new secondary.
+
+
ACTIVATE-DISKSactivate-disks
+ --submitinstance
@@ -684,17 +1680,25 @@
successful, the command will show the location and name of
the block devices:
-node1.example.com:sda:/dev/md0
-node1.example.com:sdb:/dev/md1
+node1.example.com:disk/0:/dev/drbd0
+node1.example.com:disk/1:/dev/drbd1
In this example, node1.example.com is
the name of the node on which the devices have been
- activated. The sda and
- sdb are the names of the block devices
- inside the instance. /dev/md0 and
- /dev/md1 are the names of the block
- devices as visible on the node.
+ 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 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.
@@ -708,17 +1712,115 @@ node1.example.com:sdb:/dev/md1
deactivate-disks
+ --submitinstance
De-activates the block devices of the given instance. Note
- that if you run this command for a remote raid instance
- type, while it is running, it will not be able to shutdown
- the block devices on the primary node, but it will shutdown
- the block devices on the secondary nodes, thus breaking the
- replication.
+ that if you run this command for an instance with a drbd
+ disk template, while it is running, it will not be able to
+ shutdown the block devices on the primary node, but it will
+ shutdown the block devices on the secondary nodes, thus
+ breaking the replication.
+
+
+
+ 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.
+
+
+
+
+
+ GROW-DISK
+
+ grow-disk
+ --no-wait-for-sync
+ --submit
+ instance
+ disk
+ amount
+
+
+
+ Grows an instance's disk. This is only possible for
+ instances having a plain or
+ drbd disk template.
+
+
+
+ Note that this command only change the block device size; it
+ will not grow the actual filesystems, partitions, etc. that
+ live on that disk. Usually, you will need to:
+
+
+ use gnt-instance grow-disk
+
+
+ reboot the instance (later, at a convenient
+ time)
+
+
+ use a filesystem resizer, such as
+ ext2online
+ 8 or
+ xfs_growfs
+ 8 to resize the
+ filesystem, or use
+ fdisk
+ 8 to change 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.
+
+
+
+ Note that the disk grow operation might complete on one node
+ but fail on the other; this will leave the instance with
+ different-sized LVs on the two nodes, but this will not
+ 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
+ option.
+
+
+
+ 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.
+
+
+
+ Example (increase the first disk for instance1 by 16GiB):
+
+# gnt-instance grow-disk instance1.example.com 0 16g
+
+
+
+
+ Also note that disk shrinking is not supported; use
+ gnt-backup export and then
+ gnt-backup import to reduce the disk size
+ of an instance.
+
@@ -733,13 +1835,14 @@ node1.example.com:sdb:/dev/md1
failover-f--ignore-consistency
+ --submitinstance
Failover will fail the instance over its secondary
- node. This works only for instances having a remote raid
- disk layout.
+ node. This works only for instances having a drbd disk
+ template.
@@ -747,7 +1850,17 @@ node1.example.com:sdb:/dev/md1
disks before failing over the instance. If you are trying to
migrate instances off a dead node, this will fail. Use the
option for this
- purpose.
+ purpose. Note that this option can be dangerous as errors in
+ shutting down the instance will be ignored, resulting in
+ possibly having the instance running on two machines in
+ parallel (on disconnected DRBD drives).
+
+
+
+ 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.
@@ -758,6 +1871,84 @@ node1.example.com:sdb:/dev/md1
+
+ MIGRATE
+
+
+ migrate
+ -f
+ --cleanup
+ instance
+
+
+
+ migrate
+ -f
+ --non-live
+ instance
+
+
+
+ Migrate will move the instance to its secondary node without
+ shutdown. It only works for instances having the drbd8 disk
+ template type.
+
+
+
+ The migration command needs a perfectly healthy instance, as
+ we rely on the dual-master capability of drbd8 and the disks
+ of the instance are not allowed to be degraded.
+
+
+
+ The option will switch (for the
+ hypervisors that support it) between a "fully live"
+ (i.e. the interruption is as minimal as possible) migration
+ and one in which the instance is frozen, its state saved and
+ transported to the remote node, and then resumed there. This
+ all depends on the hypervisor support for two different
+ methods. In any case, it is not an error to pass this
+ parameter (it will just be ignored if the hypervisor doesn't
+ support it).
+
+
+
+ If the 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 are
+ configured correctly. In this mode, the
+ option is ignored.
+
+
+
+ The option will skip the prompting for
+ confirmation.
+
+
+ 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?
+y/[n]/?: y
+* checking disk consistency between source and target
+* ensuring the target is in secondary mode
+* changing disks into dual-master mode
+ - INFO: Waiting for instance instance1 to sync disks.
+ - INFO: Instance instance1's disks are in sync.
+* 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
+#
+
+
+
+