[PATCH 2/2] docs: formatdomain: Mention nbd_tls_x509_secret_uuid

[Han Han]

On Wed, Sep 16, 2020 at 3:12 PM Peter Krempa <pkrempa at redhat.com> wrote:

> On Wed, Sep 16, 2020 at 13:49:27 +0800, Han Han wrote:
> > Signed-off-by: Han Han <hhan at redhat.com>
> > ---
> >  docs/formatdomain.rst | 7 +++++--
> >  1 file changed, 5 insertions(+), 2 deletions(-)
> >
> > diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
> > index 49713a12d4..73ca4e009f 100644
> > --- a/docs/formatdomain.rst
> > +++ b/docs/formatdomain.rst
> > @@ -2518,8 +2518,11 @@ paravirtualized driver is specified via the
> ``disk`` element.
> >        For "nbd", the ``name`` attribute is optional. TLS transport for
> NBD can
> >        be enabled by setting the ``tls`` attribute to ``yes``. For the
> QEMU
> >        hypervisor, usage of a TLS environment can also be globally
> controlled on
> > -      the host by the ``nbd_tls`` and ``nbd_tls_x509_cert_dir`` in
> > -      /etc/libvirt/qemu.conf. ('tls' :since:`Since 4.5.0` )
> > +      the host by the ``nbd_tls`` and ``nbd_tls_x509_cert_dir``
> > +      ('tls' :since:`Since 4.5.0` ), and the
> ``nbd_tls_x509_secret_uuid`` to
> > +      use a secret to store the passphrase for TLS client
> > +      ( :since:`Since 6.6.0` ). All these nbd configurations for QEMU
> is in
> > +      /etc/libvirt/qemu.conf .
>
> I must say I'm not particularly a fan of mentioning qemu.conf options at
> all in the XML docs.
>
yeah. formatdomain doc is very long now and adding the options of qemu.conf
will
make it more complex.
Maybe we can consider put the **nbd_tls_x509_secret_uuid** to another doc,
for example a detailed disk environment setup doc in kbase

>
> We do have it there at this point. I'd vote for getting rid of it but
> let's leave some space to discuss it.
>
>

-- 
Best regards,
-----------------------------------
Han Han
Senior Quality Engineer
Redhat.

Email: hhan at redhat.com
Phone: +861065339333
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20200916/163c99e3/attachment-0001.htm>