Re: [libvirt PATCH 05/16] docs: add manpage for virtbhyved

On Tue, Nov 17, 2020 at 12:03 PM Daniel P. Berrangé <berrange(a)redhat.com&gt; wrote: > > This is an adaptation of the libvirtd manpage. > > Signed-off-by: Daniel P. Berrangé <berrange(a)redhat.com&gt; > --- > docs/manpages/index.rst | 7 ++ > docs/manpages/meson.build | 1 + > docs/manpages/virtbhyved.rst | 215 +++++++++++++++++++++++++++++++++++ > 3 files changed, 223 insertions(+) > create mode 100644 docs/manpages/virtbhyved.rst > > diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst > index 6a2a1e065d..da835d62ec 100644 > --- a/docs/manpages/index.rst > +++ b/docs/manpages/index.rst > @@ -12,6 +12,13 @@ These daemons provide functionality across multiple libvirt drivers > * `virtlogd(8) <virtlogd.html>`__ - libvirt log management daemon > * `virtproxyd(8) <virtproxyd.html>`__ - libvirt proxy daemon > > +Modular Driver daemons > +====================== > + > +These daemons provide functionality to a single libvirt driver > + > +* `virtbhyved(8) <virtbhyved.html>`__ - libvirt bhyve management daemon > + > Tools > ===== > > diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build > index 7d5a81ecd5..7c03cb74cf 100644 > --- a/docs/manpages/meson.build > +++ b/docs/manpages/meson.build > @@ -22,6 +22,7 @@ docs_man_files = [ > > { 'name': 'libvirtd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, > { 'name': 'virt-sanlock-cleanup', 'section': '8', 'install': conf.has('WITH_SANLOCK') }, > + { 'name': 'virtbhyved', 'section': '8', 'install': conf.has('WITH_BHYVE') }, > { 'name': 'virtlockd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, > { 'name': 'virtlogd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, > { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, > diff --git a/docs/manpages/virtbhyved.rst b/docs/manpages/virtbhyved.rst > new file mode 100644 > index 0000000000..4d1d36b161 > --- /dev/null > +++ b/docs/manpages/virtbhyved.rst > @@ -0,0 +1,215 @@ > +========== > +virtbhyved > +========== > + > +------------------------------- > +libvirt bhyve management daemon > +------------------------------- > + > +:Manual section: 8 > +:Manual group: Virtualization Support > + > +.. contents:: > + > +SYNOPSIS > +======== > + > +``virtbhyved`` [*OPTION*]... > + > + > +DESCRIPTION > +=========== > + > +The ``virtbhyved`` program is a server side daemon component of the libvirt > +virtualization management system. > + > +It is one of a collection of modular daemons that replace functionality > +previously provided by the monolithic ``libvirtd`` daemon. > + > +This daemon runs on virtualization hosts to provide management for bhyve virtual > +machines. > + > +The ``virtbhyved`` daemon only listens for requests on a local Unix domain > +socket. Remote off-host access and backwards compatibility with legacy > +clients expecting ``libvirtd`` is provided by the ``virtproxy`` daemon. > + > +Restarting ``virtbhyved`` does not interrupt running guests. Guests continue to > +operate and changes in their state will generally be picked up automatically > +during startup. None the less it is recommended to avoid restarting with > +running guests whenever practical. > + > + > +SYSTEM SOCKET ACTIVATION > +======================== > + > +The ``virtbhyved`` daemon is capable of starting in two modes. > + > +In the traditional mode, it will create and listen on UNIX sockets itself. > + > +In socket activation mode, it will rely on systemd to create and listen > +on the UNIX sockets and pass them as pre-opened file descriptors. In this > +mode most of the socket related config options in > +``/etc/libvirt/virtbhyved.conf`` will no longer have any effect. > + > +Socket activation mode is generally the default when running on a host > +OS that uses systemd. To revert to the traditional mode, all the socket > +unit files must be masked: > + > +:: > + > + $ systemctl mask virtbhyved.socket virtbhyved-ro.socket \ > + virtbhyved-admin.socket > + I don't think any OS that supports bhyve has systemd.