[virt-tools-list] [virt-viewer 3/3] man: Document [ovirt] section in .vv files

[Christophe Fergeau]

On Mon, Oct 06, 2014 at 01:16:10PM +0200, Fabiano Fidêncio wrote:
> On Mon, Oct 6, 2014 at 10:57 AM, Christophe Fergeau <cfergeau at redhat.com>
> wrote:
> 
> > Add documentation for these options even though they are mainly meant to
> > be set by the oVirt portal when it generates the .vv file.
> > ---
> >  man/remote-viewer.pod | 31 +++++++++++++++++++++++++++++++
> >  1 file changed, 31 insertions(+)
> >
> > diff --git a/man/remote-viewer.pod b/man/remote-viewer.pod
> > index 2526675..7e8718b 100644
> > --- a/man/remote-viewer.pod
> > +++ b/man/remote-viewer.pod
> > @@ -270,6 +270,37 @@ port 8080, use the value "http://foobar:8080".
> >
> >  =back
> >
> > +=head2 oVirt Support
> > +
> > +The connection file can also carry some oVirt-specific options when oVirt
> > +support is compiled in. These options are used to interact with oVirt
> > REST API.
> > +This is currently only used in order to show a menu allowing to change
> > the CD
> > +image being used by the virtual machine from remote-viewer user interface.
> > +These options go in an optional [ovirt] group.
> > +
> > +=over 4
> > +
> > +=item C<host> (string, mandatory)
> > +
> > +The oVirt instance to connect to. This corresponds to the hostname one
> > would
> > +connect to to access the oVirt user or admin portal.
> > +
> > +=item C<vm-guid> (string, mandatory)
> >
> 
> Is the vm-guid really mandatory? Even after Pavel's patches to open a
> dialog showing which VMs you can connect from an oVirt domain?

This [ovirt] section is only used to provide connection details to
populate the cdrom menu. The connection to the display, .. is handled
through different parameters in the [virt-viewer] section. If we fail to
get the list of cd images available for the VM, we don't want to notify
the user except for the missing menu item. So yes, vm-guid is mandatory
in order to get the menu. If it's not there,  the connection will
still work, but without the cdrom menu. I think it's actually better if
I remove/clarify 'mandatory' in the context of the [ovirt] section.

Christophe

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/virt-tools-list/attachments/20141009/dbc1077c/attachment.sig>