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

Tue Nov 17 20:01:56 UTC 2020

On Tue, Nov 17, 2020 at 12:03 PM Daniel P. Berrangé <berrange at redhat.com> wrote:
>
> This is an adaptation of the libvirtd manpage.
>
> Signed-off-by: Daniel P. Berrangé <berrange at redhat.com>
> ---
>  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.

-Ryan

> +OPTIONS
> +=======
> +
> +``-h``, ``--help``
> +
> +Display command line help usage then exit.
> +
> +``-d``, ``--daemon``
> +
> +Run as a daemon & write PID file.
> +
> +``-f``, ``--config *FILE*``
> +
> +Use this configuration file, overriding the default value.
> +
> +``-p``, ``--pid-file *FILE*``
> +
> +Use this name for the PID file, overriding the default value.
> +
> +``-t``, ``--timeout *SECONDS*``
> +
> +Exit after timeout period (in seconds), provided there are neither any client
> +connections nor any running domains.
> +
> +``-v``, ``--verbose``
> +
> +Enable output of verbose messages.
> +
> +``--version``
> +
> +Display version information then exit.
> +
> +
> +SIGNALS
> +=======
> +
> +On receipt of ``SIGHUP`` ``virtbhyved`` will reload its configuration.
> +
> +
> +FILES
> +=====
> +
> +When run as *root*
> +------------------
> +
> +* ``@SYSCONFDIR@/libvirt/virtbhyved.conf``
> +
> +The default configuration file used by ``virtbhyved``, unless overridden on the
> +command line using the ``-f`` | ``--config`` option.
> +
> +* ``@RUNSTATEDIR@/libvirt/virtbhyved-sock``
> +* ``@RUNSTATEDIR@/libvirt/virtbhyved-sock-ro``
> +* ``@RUNSTATEDIR@/libvirt/virtbhyved-admin-sock``
> +
> +The sockets ``virtbhyved`` will use.
> +
> +The TLS **Server** private key ``virtbhyved`` will use.
> +
> +* ``@RUNSTATEDIR@/virtbhyved.pid``
> +
> +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option.
> +
> +
> +When run as *non-root*
> +----------------------
> +
> +* ``$XDG_CONFIG_HOME/libvirt/virtbhyved.conf``
> +
> +The default configuration file used by ``virtbhyved``, unless overridden on the
> +command line using the ``-f``|``--config`` option.
> +
> +* ``$XDG_RUNTIME_DIR/libvirt/virtbhyved-sock``
> +* ``$XDG_RUNTIME_DIR/libvirt/virtbhyved-admin-sock``
> +
> +The sockets ``virtbhyved`` will use.
> +
> +* ``$XDG_RUNTIME_DIR/libvirt/virtbhyved.pid``
> +
> +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option.
> +
> +
> +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtbhyved`` will use
> +``$HOME/.config``
> +
> +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtbhyved`` will use
> +``$HOME/.cache``
> +
> +
> +EXAMPLES
> +========
> +
> +To retrieve the version of ``virtbhyved``:
> +
> +::
> +
> +  # virtbhyved --version
> +  virtbhyved (libvirt) @VERSION@
> +
> +
> +To start ``virtbhyved``, instructing it to daemonize and create a PID file:
> +
> +::
> +
> +  # virtbhyved -d
> +  # ls -la @RUNSTATEDIR@/virtbhyved.pid
> +  -rw-r--r-- 1 root root 6 Jul  9 02:40 @RUNSTATEDIR@/virtbhyved.pid
> +
> +
> +BUGS
> +====
> +
> +Please report all bugs you discover.  This should be done via either:
> +
> +#. the mailing list
> +
> +   `https://libvirt.org/contact.html <https://libvirt.org/contact.html>`_
> +
> +#. the bug tracker
> +
> +   `https://libvirt.org/bugs.html <https://libvirt.org/bugs.html>`_
> +
> +Alternatively, you may report bugs to your software distributor / vendor.
> +
> +
> +AUTHORS
> +=======
> +
> +Please refer to the AUTHORS file distributed with libvirt.
> +
> +
> +COPYRIGHT
> +=========
> +
> +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the
> +libvirt AUTHORS file.
> +
> +
> +LICENSE
> +=======
> +
> +``virtbhyved`` is distributed under the terms of the GNU LGPL v2.1+.
> +This is free software; see the source for copying conditions. There
> +is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
> +PURPOSE
> +
> +
> +SEE ALSO
> +========
> +
> +virsh(1), libvirtd(8),
> +`https://www.libvirt.org/daemons.html <https://www.libvirt.org/daemons.html>`_,
> +`https://www.libvirt.org/drvbhyve.html <https://www.libvirt.org/drvbhyve.html>`_
> --
> 2.28.0
>

-- 
Ryan Moeller
iXsystems, Inc.
OS Developer
Email: ryan at iXsystems.com