<arg>--swap-size <replaceable>disksize</replaceable></arg>
<arg>-m <replaceable>memsize</replaceable></arg>
<sbr>
- <arg>-o <replaceable>os-type</replaceable></arg>
+
<arg>-b <replaceable>bridge</replaceable></arg>
<arg>--mac <replaceable>MAC-address</replaceable></arg>
+ <sbr>
+
<arg>--hvm-boot-order <replaceable>boot-order</replaceable></arg>
<sbr>
- <arg>--kernel <group choice="req">
+
+ <arg>--kernel<group choice="req">
<arg>default</arg>
<arg><replaceable>kernel_path</replaceable></arg>
</group></arg>
<sbr>
- <arg>--initrd <group choice="req">
+
+ <arg>--initrd<group choice="req">
<arg>default</arg>
<arg>none</arg>
<arg><replaceable>initrd_path</replaceable></arg>
- </group> </arg>
+ </group></arg>
<sbr>
- <arg choice="req">-t<group>
+
+ <arg>--file-storage-dir <replaceable>dir_path</replaceable></arg>
+ <arg>--file-driver<group choice="req">
+ <arg>loop</arg>
+ <arg>blktap</arg>
+ </group></arg>
+ <sbr>
+
+ <arg choice="req">-t<group choice="req">
<arg>diskless</arg>
+ <arg>file</arg>
<arg>plain</arg>
<arg>drbd</arg>
- </group>
- </arg>
+ </group></arg>
<sbr>
+
<arg choice="req">-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg>
+ <arg choice="req">-o <replaceable>os-type</replaceable></arg>
+ <sbr>
+
<arg choice="req"><replaceable>instance</replaceable></arg>
</cmdsynopsis>
</listitem>
</varlistentry>
<varlistentry>
+ <term>file</term>
+ <listitem>
+ <para>Disk devices will be regular files.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term>plain</term>
<listitem>
<para>Disk devices will be logical volumes.</para>
<para>
The optional second value of the <option>--node</option> is used for
- the remote raid template type and specifies the remote node.
+ the drbd template type and specifies the remote node.
</para>
<para>
</para>
<para>
+ The <option>--file-storage-dir</option> 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.
+ </para>
+
+ <para>
+ The <option>--file-driver</option> 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:
+ <variablelist>
+ <varlistentry>
+ <term>loop</term>
+ <listitem>
+ <para>Kernel loopback driver.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>blktap</term>
+ <listitem>
+ <para>blktap driver.</para>
+ </listitem>
+ </varlistentry>
+ <variablelist>
+ </para>
+
+ <para>
+ The loop 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.
+ </para>
+
+ <para>
+ 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.
+ </para>
+
+ <para>
Example:
<screen>
+# gnt-instance add -t file -s 30g -m 512 -o debian-etch \
+ -n node1.example.com --file-storage-dir=mysubdir instance1.example.com
# gnt-instance add -t plain -s 30g -m 512 -o debian-etch \
-n node1.example.com instance1.example.com
# gnt-instance add -t drbd -s 30g -m 512 -o debian-etch \
<command>list</command>
<arg>--no-headers</arg>
<arg>--separator=<replaceable>SEPARATOR</replaceable></arg>
- <arg>-o <replaceable>FIELD,...</replaceable></arg>
+ <arg>-o <replaceable>[+]FIELD,...</replaceable></arg>
</cmdsynopsis>
<para>
</para>
<para>
+ If the value of the option starts with the character
+ <constant>+</constant>, the new fields 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.
+ </para>
+
+ <para>
There is a subtle grouping about the available output
- fields: all fields except for <option>oper_state</option>
- and <option>oper_ram</option> are configuration value and
- not run-time values. So if you don't select any of the
- <option>oper_*</option> fields, the query will be satisfied
+ fields: all fields except for <option>oper_state</option>,
+ <option>oper_ram</option> and <option>status</option> 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
Show detailed information about the (given) instances. This
is different from <command>list</command> as it shows
detailed data about the instance's disks (especially useful
- for remote raid templates).
+ for drbd disk template).
</para>
</refsect3>
<title>CONSOLE</title>
<cmdsynopsis>
<command>console</command>
+ <arg choice="opt">--show-cmd</arg>
<arg choice="req"><replaceable>instance</replaceable></arg>
</cmdsynopsis>
<para>
Connects to the console of the given instance. If the instance
- is not up, an error is returned.
+ is not up, an error is returned. Use the <option>--show-cmd</option>
+ option to display the command instead of executing it.
</para>
<para>
<cmdsynopsis>
<command>replace-disks</command>
- <arg choice="opt">--new-secondary <replaceable>NODE</replaceable></arg>
- <arg choice="req"><replaceable>instance</replaceable></arg>
- </cmdsynopsis>
-
- <cmdsynopsis>
- <command>replace-disks</command>
<arg choice="opt">-s</arg>
<arg choice="req">--new-secondary <replaceable>NODE</replaceable></arg>
<arg choice="req"><replaceable>instance</replaceable></arg>
<para>
This command is a generalized form for adding and replacing
- disks.
- </para>
-
- <para>
- The first form is usable with the
- <literal>remote_raid1</literal> disk template. This will
- replace the disks on both the primary and secondary node,
- and optionally will change the secondary node to a new one
- if you pass the <option>--new-secondary</option> option.
+ disks. It is currently only valid for the mirrored (DRBD)
+ disk template.
</para>
<para>
- The second and third forms are usable with the
- <literal>drbd</literal> disk template. The second form will
- do a secondary replacement, but as opposed to the
- <literal>remote_raid1</literal> will not replace the disks
- on the primary, therefore it will execute faster. The third
- form will replace the disks on either the primary
+ The first form will do a secondary node change, while the
+ second form will replace the disks on either the primary
(<option>-p</option>) or the secondary (<option>-s</option>)
node of the instance only, without changing the node.
</para>
successful, the command will show the location and name of
the block devices:
<screen>
-node1.example.com:sda:/dev/md0
-node1.example.com:sdb:/dev/md1
+node1.example.com:sda:/dev/drbd0
+node1.example.com:sdb:/dev/drbd1
</screen>
In this example, <emphasis>node1.example.com</emphasis> is
the name of the node on which the devices have been
activated. The <emphasis>sda</emphasis> and
<emphasis>sdb</emphasis> are the names of the block devices
- inside the instance. <emphasis>/dev/md0</emphasis> and
- <emphasis>/dev/md1</emphasis> are the names of the block
+ inside the instance. <emphasis>/dev/drbd0</emphasis> and
+ <emphasis>/dev/drbd1</emphasis> are the names of the block
devices as visible on the node.
</para>
</cmdsynopsis>
<para>
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.
</para>
</refsect3>
<para>
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.
</para>
<para>
projects / ganeti-local / blobdiff