X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/bd028152c6323f4d3107d123cbf220ca37c42465..7e9366f7b0c77b63d7c4cc971ac06125ac34b48c:/man/gnt-instance.sgml diff --git a/man/gnt-instance.sgml b/man/gnt-instance.sgml index e79f05f..e6d190e 100644 --- a/man/gnt-instance.sgml +++ b/man/gnt-instance.sgml @@ -2,7 +2,7 @@ - May 16, 2007"> + May 29, 2008"> 8"> @@ -20,6 +20,7 @@ 2006 2007 + 2008 Google Inc. &dhdate; @@ -72,6 +73,25 @@ --hvm-boot-order boot-order + --hvm-acpi ACPI-support + + + --hvm-pae PAE-support + + + --hvm-cdrom-image-path + cdrom-image-path + + + --hvm-nic-type NICTYPE + + + --hvm-disk-type + DISKTYPE + + + --vnc-bind-address + vnc-bind-address --kernel @@ -102,7 +122,12 @@ - -n node:secondary-node + + -n node:secondary-node + --iallocator name + + + -o os-type @@ -206,12 +231,70 @@ - The option is only relevant for Xen HVM instances and - ignored by all other instances types. + The default is not to set an HVM boot order which is + interpreted as 'dc'. This option, like all options starting + with 'hvm', is only relevant for Xen HVM instances and + ignored by all other instance types. + + + + The option specifies if Xen + should enable ACPI support for this HVM instance. Valid + values are true or false. The default value is false, + disabling ACPI support for this instance. + + + + The option specifies if Xen + should enabled PAE support for this HVM instance. Valid + values are true or false. The default is false, disabling + PAE support for this instance. - The options allows the instance to + The option specifies the + path to the file Xen uses to emulate a virtual CDROM drive + for this HVM instance. Valid values are either an + absolute path to an existing file or None, which disables + virtual CDROM support for this instance. The default is + None, disabling virtual CDROM support. + + + + The specifies the NIC type + Xen should use for this HVM instance. Valid choices are + rtl8139, ne2k_pci, ne2k_isa and paravirtual with rtl8139 + as the default. The paravirtual setting is intended for use + with the GPL PV drivers inside HVM Windows instances. + + + + The specifies the disk type + Xen should use for the HVM instance. Valid choices are ioemu + and paravirtual with ioemu as the default. The paravirtual + setting is intended for use with the GPL PV drivers inside + HVM Windows instances. + + + + The option 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. + + + + 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. + + + + The option allows the instance to use a custom kernel (if a filename is passed) or to use the default kernel (@CUSTOM_XEN_KERNEL@), if the string default is passed. @@ -308,7 +391,7 @@ blktap driver. - + @@ -522,6 +605,22 @@ 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 detect modifications + + @@ -562,6 +661,10 @@ info + + -s + --static + instance @@ -571,6 +674,12 @@ detailed data about the instance's disks (especially useful for drbd disk template). + + + If the option is used, only information + available in the configuration file is returned, without + querying nodes, making the operation faster. + @@ -584,6 +693,15 @@ -b bridge --mac MAC-address --hvm-boot-order boot-order + --hvm-acpi ACPI-support + --hvm-pae PAE-support + --hvm-cdrom-image-path + cdrom-image-path + --hvm-nic-type NICTYPE + --hvm-disk-type DISKTYPE + --vnc-bind-address + vnc-bind-address + --kernel default @@ -622,6 +740,49 @@ + The option specifies if Xen + should enable ACPI support for this HVM instance. Valid + values are true or false. + + + + The option specifies if Xen + should enabled PAE support for this HVM instance. Valid + values are true or false. + + + + The specifies the + path to the file xen uses to emulate a virtual CDROM drive + for this HVM instance. Valid values are either an + absolute path to an existing file or None, which disables + virtual CDROM support for this instance. + + + + The specifies the NIC type + Xen should use for this HVM instance. Valid choices are + rtl8139, ne2k_pci, ne2k_isa and paravirtual with rtl8139 + as the default. The paravirtual setting is intended for use + with the GPL PV drivers inside HVM Windows instances. + + + + The specifies the disk type + Xen should use for the HVM instance. Valid choices are ioemu + and paravirtual with ioemu as the default. The paravirtual + setting is intended for use with the GPL PV drivers inside + HVM Windows instances. + + + + The 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. + + + All the changes take effect at the next restart. If the instance is running, there is no effect on the instance. @@ -634,6 +795,7 @@ reinstall -o os-type -f force + --select-os instance @@ -643,6 +805,12 @@ 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. + @@ -843,7 +1011,7 @@ 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 soft reboot. + startup. The default is hard reboot. @@ -890,6 +1058,13 @@ + 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 gnt-instance info. + + + Example: # gnt-instance console instance1.example.com @@ -907,17 +1082,25 @@ replace-disks - -s - --new-secondary NODE + -p instance replace-disks - + -s - -p + instance + + + + replace-disks + + + --iallocator name + --new-secondary NODE + instance @@ -928,12 +1111,22 @@ - The first form will do a secondary node change, while the - second form will replace the disks on either the primary - () or the secondary () - node of the instance only, without changing the node. + 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. + + 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. + @@ -985,6 +1178,88 @@ node1.example.com:sdb:/dev/drbd1 + + GROW-DISK + + grow-disk + --no-wait-for-sync + 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 either + sda or sdb. 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. + + + + Example (increase sda for instance1 by 16GiB): + +# gnt-instance grow-disk instance1.example.com sda 16g + + + + + Also note that disk shrinking will not be supported; use + gnt-backup export and then + gnt-backup import to reduce the disk size + of an instance. + + +