[libvirt] [PATCH 4/5] formatdomain: Fix issues found describing auth
Fix a couple of typos ('chap' should have been 'iscsi' and there was
a stray 'iqn.2013-07.com.example:iscsi-pool' entry. Clean up the
description of the <auth> element for the disk
Signed-off-by: John Ferlan <jferlan(a)redhat.com>
---
docs/formatdomain.html.in | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 3075e16..d3e776b 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1594,18 +1594,17 @@
<host name='example.com' port='3260'/>
</source>
<auth username='myuser'>
- <secret type='chap' usage='libvirtiscsi'/>
+ <secret type='iscsi' 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-07.com.example:iscsi-nopool/1'>
- iqn.2013-07.com.example:iscsi-pool
<host name='example.com' port='3260'/>
</source>
<auth username='myuser'>
- <secret type='chap' usage='libvirtiscsi'/>
+ <secret type='iscsi' usage='libvirtiscsi'/>
</auth>
<target dev='sda' bus='scsi'/>
</disk>
@@ -1613,7 +1612,7 @@
<driver name='qemu' type='raw'/>
<source pool='iscsi-pool' volume='unit:0:0:1'
mode='host'/>
<auth username='myuser'>
- <secret type='chap' usage='libvirtiscsi'/>
+ <secret type='iscsi' usage='libvirtiscsi'/>
</auth>
<target dev='vda' bus='virtio'/>
</disk>
@@ -1621,7 +1620,7 @@
<driver name='qemu' type='raw'/>
<source pool='iscsi-pool' volume='unit:0:0:2'
mode='direct'/>
<auth username='myuser'>
- <secret type='chap' usage='libvirtiscsi'/>
+ <secret type='iscsi' usage='libvirtiscsi'/>
</auth>
<target dev='vda' bus='virtio'/>
</disk>
@@ -2180,7 +2179,10 @@
are available, each defaulting to 0.
</dd>
<dt><code>auth</code></dt>
- <dd>If present, the <code>auth</code> element provides the
+ <dd>The <code>auth</code> element is supported for a disk
+ <code>type</code> "network" that is using a
<code>source</code>
+ element with the <code>protocol</code> attributes "rbd" or
"iscsi".
+ If present, the <code>auth</code> element provides the
authentication credentials needed to access the source. It
includes a mandatory attribute <code>username</code>, which
identifies the username to use during authentication, as well
@@ -2189,11 +2191,11 @@
a <a href="formatsecret.html">libvirt secret object</a>
that
holds the actual password or other credentials (the domain XML
intentionally does not expose the password, only the reference
- to the object that does manage the password). For now, the
- known secret <code>type</code>s are "ceph", for Ceph RBD
- network sources, and "iscsi", for CHAP authentication of iSCSI
- targets. Both require either a <code>uuid</code> attribute
- with the UUID of the secret object, or a <code>usage</code>
+ to the object that does manage the password).
+ Known secret types are "ceph" for Ceph RBD network sources and
+ "iscsi" for CHAP authentication of iSCSI targets.
+ Both will require either a <code>uuid</code> attribute
+ with the UUID of the secret object or a <code>usage</code>
attribute matching the key that was specified in the
secret object. <span class="since">libvirt 0.9.7</span>
</dd>
--
1.9.3