[libvirt] [PATCH 05/10] docs: storage: Document <auth> element

[Daniel P. Berrange]

On Mon, Feb 22, 2010 at 05:10:53PM -0500, Cole Robinson wrote:
> 
> Signed-off-by: Cole Robinson <crobinso at redhat.com>
> ---
>  docs/formatstorage.html.in |    8 ++++++++
>  docs/storage.html.in       |    1 +
>  2 files changed, 9 insertions(+), 0 deletions(-)
> 
> diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in
> index 7ececed..855d475 100644
> --- a/docs/formatstorage.html.in
> +++ b/docs/formatstorage.html.in
> @@ -70,6 +70,7 @@
>          <source>
>            <host name="iscsi.example.com"/>
>            <device path="demo-target"/>
> +          <auth type="chap" login="foobar" passwd="foo-passwd"/>
>          </source>
>          ...</pre>
>  
> @@ -103,6 +104,13 @@
>          type, or network filesystem type, or partition table type, or
>          LVM metadata type. All drivers are required to have a default
>          value for this, so it is optional. <span class="since">Since 0.4.1</span></dd>
> +      <dt><code>auth</code></dt>
> +      <dd>Provides login information for an iSCSI pools server.
> +      <code>type</code> is a required attribute which specifies the
> +      authentication method. Currently only <code>chap</code>
> +      (challenge-handshake) is supported. <code>login</code> and
> +      <code>passwd</code> specify the login and password respectively.
> +        <span class="since">Since 0.4.1</span></dd>
>      </dl>
>  
>      <h3><a name="StoragePoolTarget">Target elements</a></h3>

Our iSCSI backend never actually implemented any of this, so its a little
bit misleading & probably a bad idea in the XML in any case. I'm inclined
to actually remove this from the XML parser since it was never used.

> diff --git a/docs/storage.html.in b/docs/storage.html.in
> index 904fc7c..a3399c6 100644
> --- a/docs/storage.html.in
> +++ b/docs/storage.html.in
> @@ -329,6 +329,7 @@ libvirt.
>          <source>
>            <host name="iscsi.example.com"/>
>            <device path="demo-target"/>
> +          <auth type="chap" login="foobar" passwd="foo-passwd"/>
>          </source>
>          <target>
>            <path>/dev/disk/by-path</path>
> -- 

Daniel
-- 
|: Red Hat, Engineering, London    -o-   http://people.redhat.com/berrange/ :|
|: http://libvirt.org -o- http://virt-manager.org -o- http://deltacloud.org :|
|: http://autobuild.org        -o-         http://search.cpan.org/~danberr/ :|
|: GnuPG: 7D3B9505  -o-   F3C9 553F A1DA 4AC2 5648 23C1 B3DF F742 7D3B 9505 :|