<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!-- Please adjust the date whenever revising the manpage. -->
- <!ENTITY dhdate "<date>May 29, 2008</date>">
+ <!ENTITY dhdate "<date>July 01, 2008</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>8</manvolnum>">
<replaceable>cdrom-image-path</replaceable></arg>
<sbr>
+ <arg>--hvm-nic-type <replaceable>NICTYPE</replacable></arg>
+ <sbr>
+
+ <arg>--hvm-disk-type
+ <replaceale>DISKTYPE</replaceable></arg>
+ <sbr>
+
<arg>--vnc-bind-address
<replaceable>vnc-bind-address</replaceable></arg>
<sbr>
</group></arg>
<sbr>
+ <arg>--cpu <replaceable>vcpus</replaceable></arg>
+ <arg>--ip<group choice="req">
+ <arg>default</arg>
+ <arg>none</arg>
+ <arg><replaceable>ip-address</replaceable></arg>
+ </group></arg>
+ <sbr>
+
+ <arg>--no-wait-for-sync</arg>
+ <arg>--no-start</arg>
+ <arg>--no-ip-check</arg>
+ <sbr>
+
<arg choice="req">-t<group choice="req">
<arg>diskless</arg>
<arg>plain</arg>
</para>
<para>
- 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.
</para>
<para>
The <option>--hvm-acpi</option> option specifies if Xen
should enable ACPI support for this HVM instance. Valid
- values are true or false.
+ values are true or false. The default value is false,
+ disabling ACPI support for this instance.
</para>
<para>
The <option>--hvm-pae</option> option specifies if Xen
should enabled PAE support for this HVM instance. Valid
- values are true or false.
+ values are true or false. The default is false, disabling
+ PAE support for this instance.
</para>
<para>
The <option>--hvm-cdrom-image-path</option> option specifies the
- path to the file xen uses to emulate a virtual CDROM drive
+ 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.
+ virtual CDROM support for this instance. The default is
+ None, disabling virtual CDROM support.
+ </para>
+
+ <para>
+ The <option>--hvm-nic-type</option> 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.
+ </para>
+
+ <para>
+ The <option>--hvm-disk-type</option> 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.
</para>
<para>
The <option>--vnc-bind-address</option> 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.
+ to bind to all available interfaces (this is the default)
+ or specify the address of one of the interfaces on the node
+ to restrict listing to that interface.
</para>
<para>
</para>
<para>
+ Use the <option>--cpu</option> option to set the number of virtual
+ CPUs.
+ </para>
+
+ <para>
+ To pass an IPv4 address to the hypervisor, specify the
+ <option>--ip</option> option. Note that this IP address will not be
+ used by the OS scripts and changing it later will change the address
+ that the instance will actually use.
+ </para>
+
+ <para>
+ In case you don't want the new instance to be automatically started,
+ specify the <option>--no-start</option> option.
+ </para>
+
+ <para>
+ Ganeti will not check whether an instance's IP address is already
+ alive if the <option>--no-ip-check</option> option is specified.
+ </para>
+
+ <para>
Example:
<screen>
# gnt-instance add -t plain -s 30g -m 512 -o debian-etch \
<arg>--hvm-pae <replaceable>PAE-support</replaceable></arg>
<arg>--hvm-cdrom-image-path
<replaceable>cdrom-image-path</replaceable></arg>
+ <arg>--hvm-nic-type <replaceable>NICTYPE</replaceable></arg>
+ <arg>--hvm-disk-type <replaceable>DISKTYPE</replaceable></arg>
<arg>--vnc-bind-address
<replaceable>vnc-bind-address</replaceable></arg>
</para>
<para>
+ The <option>--hvm-nic-type</option> 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.
+ </para>
+
+ <para>
+ The <option>--hvm-disk-type</option> 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.
+ </para>
+
+ <para>
The <option>--vnc-bind-address</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
<command>reinstall</command>
<arg choice="opt">-o <replaceable>os-type</replaceable></arg>
<arg choice="opt">-f <replaceable>force</replaceable></arg>
+ <arg>--interactive</arg>
<arg choice="req"><replaceable>instance</replaceable></arg>
</cmdsynopsis>
<option>--os-type</option> is specified, the operating system is
changed.
</para>
+
+ <para>
+ The <option>--interactive</option> option switches to an
+ interactive reinstall. The user is prompted to select the OS
+ template from the list of available OS templates.
+ </para>
</refsect3>
<refsect3>
<title>GROW-DISK</title>
<cmdsynopsis>
<command>grow-disk</command>
+ <arg>--no-wait-for-sync</arg>
<arg choice="req"><replaceable>instance</replaceable></arg>
<arg choice="req"><replaceable>disk</replaceable></arg>
<arg choice="req"><replaceable>amount</replaceable></arg>
create problems (except for unused space).
</para>
- <para>Example (increasing sda for instance1 with 16GiB):
+ <para>
+ If you do not want gnt-instance to wait for the new disk
+ region to be synced, use the
+ <option>--no-wait-for-sync</option> option.
+ </para>
+
+
+ <para>Example (increase sda for instance1 by 16GiB):
<screen>
# gnt-instance grow-disk instance1.example.com sda 16g
</screen>
</para>
</refsect3>
+ <refsect3>
+ <title>MIGRATE</title>
+
+ <cmdsynopsis>
+ <command>migrate</command>
+ <arg>-f</arg>
+ <arg choice="req">--cleanup</arg>
+ <arg choice="req"><replaceable>instance</replaceable></arg>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>migrate</command>
+ <arg>-f</arg>
+ <arg>--non-live</arg>
+ <arg choice="req"><replaceable>instance</replaceable></arg>
+ </cmdsynopsis>
+
+ <para>
+ Migrate will move the instance to its secondary node without
+ shutdown. It only works for instances having the drbd8 disk
+ template type.
+ </para>
+
+ <para>
+ 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.
+ </para>
+
+ <para>
+ The <option>--non-live</option> 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).
+ </para>
+
+ <para>
+ If the <option>--cleanup</option> 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>--non-live</option> option is ignored.
+ </para>
+
+ <para>
+ The option <option>-f</option> will skip the prompting for
+ confirmation.
+ </para>
+
+ <para>
+ Example (and expected output):
+ <screen>
+# 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
+#
+ </screen>
+ </para>
+ </refsect3>
+
</refsect2>
<refsect2>
projects / ganeti-local / blobdiff