On 20/08/13 21:10, John Ferlan wrote:
On 08/20/2013 03:43 AM, Osier Yang wrote:
> On 20/08/13 05:21, John Ferlan wrote:
>> >From e31f3596893302ee1f96d2eb0cf4e006294c528c Mon Sep 17 00:00:00 2001
>> From: John Ferlan <jferlan(a)redhat.com>
>> Date: Wed, 7 Aug 2013 09:05:43 -0400
>> Subject: [PATCH 4/7] docs: Update the formatdomain disk examples
>>
>> Add more iSCSI examples including having a secret attached. There are 4 new
>> examples one for each way to have an iSCSI - a network disk using virtio,
>> a passthrough network lun using scsi, a volume disk using
"mode='host'",
>> and a volume disk using "mode='direct'"
>> ---
>> docs/formatdomain.html.in | 164 ++++++++++++++++++++++++++++++++++------------
>> 1 file changed, 121 insertions(+), 43 deletions(-)
>>
>> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
>> index 4a927cc..5450be0 100644
>> --- a/docs/formatdomain.html.in
>> +++ b/docs/formatdomain.html.in
>> @@ -1518,6 +1518,42 @@
>> <source pool='blk-pool0'
volume='blk-pool0-vol0'/>
>> <target dev='hda' bus='ide'/>
>> </disk>
>> + <disk type='network' device='disk'>
>> + <driver name='qemu' type='raw'/>
>> + <source protocol='iscsi'
name='iqn.2013-06.com.example:iscsi/2'>
>> + <host name='example.com' port='3260'/>
>> + </source>
>> + <auth username='myuser'>
>> + <secret type='chap'
usage='libvirtiscsi'/>
>> + </auth>
>> + <target dev='vda' bus='virtio'/>
>> + </disk>
>> + <disk type='network' device='lun'>
>> + <driver name='qemu' type='raw'/>
>> + <source protocol='iscsi'
name='iqn.2013-06.com.example:iscsi/1'>
>> + <host name='example.com' port='3260'/>
>> + </source>
>> + <auth username='myuser'>
>> + <secret type='chap'
usage='libvirtiscsi'/>
>> + </auth>
>> + <target dev='sda' bus='scsi'/>
>> + </disk>
>> + <disk type='volume' device='disk'>
>> + <driver name='qemu' type='raw'/>
>> + <source pool='iscsi-pool' volume='unit:0:0:1'
mode='host'/>
>> + <auth username='myuser'>
>> + <secret type='chap'
usage='libvirtiscsi'/>
>> + </auth>
>> + <target dev='vda' bus='virtio'/>
>> + </disk>
>> + <disk type='volume' device='disk'>
>> + <driver name='qemu' type='raw'/>
>> + <source pool='iscsi-pool' volume='unit:0:0:2'
mode='direct'/>
>> + <auth username='myuser'>
>> + <secret type='chap'
usage='libvirtiscsi'/>
>> + </auth>
>> + <target dev='vda' bus='virtio'/>
>> + </disk>
>> </devices>
>> ...</pre>
>>
>> @@ -1525,7 +1561,7 @@
>> <dt><code>disk</code></dt>
>> <dd>The <code>disk</code> element is the main container
for describing
>> disks. The <code>type</code> attribute is either
"file",
>> - "block", "dir", or "network"
>> + "block", "dir", "network", or
"volume"
>> and refers to the underlying source for the disk. The optional
>> <code>device</code> attribute indicates how the disk is to
be exposed
>> to the guest OS. Possible values for this attribute are
>> @@ -1575,57 +1611,96 @@
>> "network" attribute since 0.8.7; "snapshot" since
>> 0.9.5</span></dd>
>> <dt><code>source</code></dt>
>> - <dd>If the disk <code>type</code> is "file",
then
>> - the <code>file</code> attribute specifies the
fully-qualified
>> - path to the file holding the disk. If the disk
>> - <code>type</code> is "block", then the
<code>dev</code>
>> - attribute specifies the path to the host device to serve as
>> - the disk. With "file", "block", and
"volume", one or more optional
>> + <dd>Representation of the disk <code>source</code>
depends on the
>> + <code>disk type</code> attribute value as follows:
> disk <code>type</code>
>
Changed
>> + <dl>
>> + <dt><code>type='file'</code>
> if you are 2 spaces as the indention......
>
>> + <span class="since">Since
0.0.3</span></dt>
>> + <dd>
>> + The <code>file</code> attribute specifies the
fully-qualified
> Then you will have enough spaces to indent lines like this with 2 spaces
> too.
>
Oh right... Rather than indent more I kept the 2 spaces as the indent,
but moved back the <dt> elements since everything under <dl> was at 4
spaces.
>> + path to the file holding the disk.
>> + </dd>
>> + <dt><code>type='block'</code>
>> + <span class="since">Since
0.0.3</span></dt>
>> + <dd>
>> + The <code>dev</code> attribute specifies the path to
the
>> + host device to serve as the disk.
>> + </dd>
>> + <dt><code>type='dir'</code>
>> + <span class="since">Since
0.7.5</span></dt>
>> + <dd>
>> + The <code>dir</code> attribute specifies the
fully-qualified path
>> + to the directory to use as the disk.
>> + </dd>
>> + <dt><code>type='network'</code>
>> + <span class="since">Since
0.8.7</span></dt>
>> + <dd>
>> + The <code>protocol</code> attribute specifies the
protocol to
>> + access to the requested image. Possible values are
"nbd",
>> + "iscsi", "rbd", "sheepdog" or
"gluster". If the
>> + <code>protocol</code> attribute is "rbd",
"sheepdog" or
>> + "gluster", an additional attribute
<code>name</code> is
>> + mandatory to specify which volume/image will be used. For
"nbd",
>> + the <code>name</code> attribute is optional. For
"iscsi"
>> + (<span class="since">since 1.0.4</span>),
the <code>name</code>
>> + attribute may include a logical unit number, separated from the
>> + target's name by a slash (e.g.,
>> + <code>iqn.2013-07.com.example:iscsi-pool/1</code>). If
not
>> + specified, the default LUN is zero.
>> + </dd>
>> + <dt><code>type='volume'</code>
>> + <span class="since">Since
1.0.5</span></dt>
>> + <dd>
>> + The underlying disk source is represented by attributes
>> + <code>pool</code> and <code>volume</code>.
Attribute
>> + <code>pool</code> specifies the name of storage pool
(managed
>> + by libvirt) where the disk source resides. Attribute
>> + <code>volume</code> specifies the name of storage
volume (managed
>> + by libvirt) used as the disk source.
>> +
>> + <p>
>> + If the underlying storage pool is "iscsi", then use the
output
>> + of the value from the "Name" column of the
<code>virsh vol-list
>> + [pool-name]</code> command for the
<code>volume</code> attribute
>> + field.
> It sounds like it only works when the storage pool is "iscsi". one can use
> "virsh vol-list" to find out the volume name for any type of storage pool.
>
>
Ah - so that's a bit of myopia trying to write something down about
iscsi that had a more general purpose. Since I was only configuring
iscsi I wasn't thinking about others - here's what I have now:
The underlying disk source is represented by attributes
<code>pool</code> and <code>volume</code>. Attribute
<code>pool</code> specifies the name of the
<a href="formatstorage.html">storage pool</a> (managed
by libvirt) where the disk source resides. Attribute
<code>volume</code> specifies the name of storage volume (managed
by libvirt) used as the disk source. The value for the
<code>volume</code> attribute will be the output from the
"Name"
column of a <code>virsh vol-list [pool-name]</code> command.
ACK for the changes.
Osier