Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/libvirtd.rst | 48 +++++++++++++++++++------------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/manpages/libvirtd.rst b/docs/manpages/libvirtd.rst index cd9976c5e4..2ce6284b3a 100644 --- a/docs/manpages/libvirtd.rst +++ b/docs/manpages/libvirtd.rst @@ -32,13 +32,13 @@ The libvirt client libraries and utilities connect to this daemon to issue tasks and collect information about the configuration and resources of the host system and guests. -By default, the libvirtd daemon listens for requests on a local Unix domain -socket. Using the ``-l`` | ``--listen`` command line option, the libvirtd daemon -can be instructed to additionally listen on a TCP/IP socket. The TCP/IP socket -to use is defined in the libvirtd configuration file. +By default, the ``libvirtd`` daemon listens for requests on a local Unix domain +socket. Using the ``-l`` | ``--listen`` command line option, the ``libvirtd`` +daemon can be instructed to additionally listen on a TCP/IP socket. The TCP/IP +socket to use is defined in the ``libvirtd`` configuration file. -Restarting libvirtd does not impact running guests. Guests continue to operate -and will be picked up automatically if their XML configuration has been +Restarting ``libvirtd`` does not impact running guests. Guests continue to +operate and will be picked up automatically if their XML configuration has been defined. Any guests whose XML configuration has not been defined will be lost from the configuration. @@ -98,8 +98,8 @@ Use this configuration file, overriding the default value. ``-l``, ``--listen`` Listen for TCP/IP connections. This should not be set if using systemd -socket activation. Instead activate the libvirtd-tls.socket or -libvirtd-tcp.socket unit files. +socket activation. Instead activate the ``libvirtd-tls.socket`` or +``libvirtd-tcp.socket`` unit files. ``-p``, ``--pid-file *FILE*`` @@ -122,7 +122,7 @@ Display version information then exit. SIGNALS ======= -On receipt of ``SIGHUP`` libvirtd will reload its configuration. +On receipt of ``SIGHUP`` ``libvirtd`` will reload its configuration. FILES @@ -133,25 +133,25 @@ When run as *root* * ``@SYSCONFDIR@/libvirt/libvirtd.conf`` -The default configuration file used by libvirtd, unless overridden on the +The default configuration file used by ``libvirtd``, unless overridden on the command line using the ``-f`` | ``--config`` option. * ``@RUNSTATEDIR@/libvirt/libvirt-sock`` * ``@RUNSTATEDIR@/libvirt/libvirt-sock-ro`` -The sockets libvirtd will use. +The sockets ``libvirtd`` will use. * ``@SYSCONFDIR@/pki/CA/cacert.pem`` -The TLS **Certificate Authority** certificate libvirtd will use. +The TLS **Certificate Authority** certificate ``libvirtd`` will use. * ``@SYSCONFDIR@/pki/libvirt/servercert.pem`` -The TLS **Server** certificate libvirtd will use. +The TLS **Server** certificate ``libvirtd`` will use. * ``@SYSCONFDIR@/pki/libvirt/private/serverkey.pem`` -The TLS **Server** private key libvirtd will use. +The TLS **Server** private key ``libvirtd`` will use. * ``@RUNSTATEDIR@/libvirtd.pid`` @@ -163,41 +163,41 @@ When run as *non-root* * ``$XDG_CONFIG_HOME/libvirt/libvirtd.conf`` -The default configuration file used by libvirtd, unless overridden on the +The default configuration file used by ``libvirtd``, unless overridden on the command line using the ``-f``|``--config`` option. * ``$XDG_RUNTIME_DIR/libvirt/libvirt-sock`` -The socket libvirtd will use. +The socket ``libvirtd`` will use. * ``$HOME/.pki/libvirt/cacert.pem`` -The TLS **Certificate Authority** certificate libvirtd will use. +The TLS **Certificate Authority** certificate ``libvirtd`` will use. * ``$HOME/.pki/libvirt/servercert.pem`` -The TLS **Server** certificate libvirtd will use. +The TLS **Server** certificate ``libvirtd`` will use. * ``$HOME/.pki/libvirt/serverkey.pem`` -The TLS **Server** private key libvirtd will use. +The TLS **Server** private key ``libvirtd`` will use. * ``$XDG_RUNTIME_DIR/libvirt/libvirtd.pid`` The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. -If ``$XDG_CONFIG_HOME`` is not set in your environment, libvirtd will use +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``libvirtd`` will use ``$HOME/.config`` -If ``$XDG_RUNTIME_DIR`` is not set in your environment, libvirtd will use +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``libvirtd`` will use ``$HOME/.cache`` EXAMPLES ======== -To retrieve the version of libvirtd: +To retrieve the version of ``libvirtd``: :: @@ -205,7 +205,7 @@ To retrieve the version of libvirtd: libvirtd (libvirt) 0.8.2 -To start libvirtd, instructing it to daemonize and create a PID file: +To start ``libvirtd``, instructing it to daemonize and create a PID file: :: @@ -246,7 +246,7 @@ libvirt AUTHORS file. LICENSE ======= -libvirtd is distributed under the terms of the GNU LGPL v2.1+. +``libvirtd`` 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 -- 2.29.2

Subsitute in the current version so the example always reflect today's version of reality. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/libvirtd.rst | 2 +- docs/manpages/meson.build | 1 + docs/manpages/virtlockd.rst | 2 +- docs/manpages/virtlogd.rst | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/manpages/libvirtd.rst b/docs/manpages/libvirtd.rst index 2ce6284b3a..ed591f4778 100644 --- a/docs/manpages/libvirtd.rst +++ b/docs/manpages/libvirtd.rst @@ -202,7 +202,7 @@ To retrieve the version of ``libvirtd``: :: # libvirtd --version - libvirtd (libvirt) 0.8.2 + libvirtd (libvirt) @VERSION@ To start ``libvirtd``, instructing it to daemonize and create a PID file: diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index 7156c10cc6..f6388b6262 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -71,6 +71,7 @@ endforeach docs_man_conf = configuration_data() docs_man_conf.set('SYSCONFDIR', sysconfdir) docs_man_conf.set('RUNSTATEDIR', runstatedir) +docs_man_conf.set('VERSION', meson.project_version()) foreach data : docs_man_files rst_in_file = '@0@.rst'.format(data['name']) diff --git a/docs/manpages/virtlockd.rst b/docs/manpages/virtlockd.rst index 8ca231d14f..0bbee5a5f7 100644 --- a/docs/manpages/virtlockd.rst +++ b/docs/manpages/virtlockd.rst @@ -123,7 +123,7 @@ To retrieve the version of ``virtlockd``: :: # virtlockd --version - virtlockd (libvirt) 1.1.1 + virtlockd (libvirt) @VERSION@ To start ``virtlockd``, instructing it to daemonize and create a PID file: diff --git a/docs/manpages/virtlogd.rst b/docs/manpages/virtlogd.rst index 4b749fe18e..1e39ff1b49 100644 --- a/docs/manpages/virtlogd.rst +++ b/docs/manpages/virtlogd.rst @@ -124,7 +124,7 @@ To retrieve the version of ``virtlogd``: :: # virtlogd --version - virtlogd (libvirt) 1.1.1 + virtlogd (libvirt) @VERSION@ To start ``virtlogd``, instructing it to daemonize and create a PID file: -- 2.29.2

This group will be distinct from the per-driver modular daemon mapages. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 3624ae4e8f..e116c6f415 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -2,8 +2,10 @@ Libvirt Manual Pages ==================== -Daemons -======= +Common Daemons +============== + +These daemons provide functionality across multiple libvirt drivers * `libvirtd(8) <libvirtd.html>`__ - libvirt management daemon * `virtlockd(8) <virtlockd.html>`__ - libvirt lock management daemon -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtproxyd.rst | 256 +++++++++++++++++++++++++++++++++++ 3 files changed, 258 insertions(+) create mode 100644 docs/manpages/virtproxyd.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index e116c6f415..6a2a1e065d 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -10,6 +10,7 @@ These daemons provide functionality across multiple libvirt drivers * `libvirtd(8) <libvirtd.html>`__ - libvirt management daemon * `virtlockd(8) <virtlockd.html>`__ - libvirt lock management daemon * `virtlogd(8) <virtlogd.html>`__ - libvirt log management daemon +* `virtproxyd(8) <virtproxyd.html>`__ - libvirt proxy daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index f6388b6262..7d5a81ecd5 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -24,6 +24,7 @@ docs_man_files = [ { 'name': 'virt-sanlock-cleanup', 'section': '8', 'install': conf.has('WITH_SANLOCK') }, { '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') }, ] foreach name : keycode_list diff --git a/docs/manpages/virtproxyd.rst b/docs/manpages/virtproxyd.rst new file mode 100644 index 0000000000..a8a0c044fa --- /dev/null +++ b/docs/manpages/virtproxyd.rst @@ -0,0 +1,256 @@ +========== +virtproxyd +========== + +-------------------- +libvirt proxy daemon +-------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtproxyd`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtproxyd`` 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 an + + * Listens on a UNIX socket to provide backwards compatibility for clients + that previously connected to the ``libvirtd`` socket. + + * Optionally listens on TCP ports for connections from off-node clients + +Upon receiving RPC messages from a client ``virtproxyd`` will transparently +forward them on to the appropriate modular daemon, and similarly relay back +any asynchronous events. + +By default, the ``virtproxyd`` daemon listens for requests on a local Unix +domain socket with the same path previously used by ``libvirtd``. The +configuration file can be used to instruct it to also listen on TCP socket(s). +Systemd socket activation is also supported to allow it to receive pre-opened +listener sockets on startup. + +Since ``virtproxyd`` merely forwards RPC mesages, it has no important state, +and can be restarted at any time. Clients should expect to reconnect after +the restart. + + +SYSTEM SOCKET ACTIVATION +======================== + +The ``virtproxyd`` daemon is capable of starting in two modes. + +In the traditional mode, it will create and listen on UNIX sockets itself. +It will also listen on TCP/IP socket(s), according to the ``listen_tcp`` +and ``listen_tls`` options in ``/etc/libvirt/virtproxyd.conf`` + +In socket activation mode, it will rely on systemd to create and listen +on the UNIX, and optionally TCP/IP, sockets and pass them as pre-opened +file descriptors. In this mode most of the socket related config options in +``/etc/libvirt/virtproxyd.conf`` will no longer have any effect. To enable +TCP or TLS sockets use either + +:: + + $ systemctl start virtproxyd-tls.socket + +Or + +:: + + $ systemctl start virtproxyd-tcp.socket + +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 virtproxyd.socket virtproxyd-ro.socket \ + virtproxyd-admin.socket virtproxyd-tls.socket virtproxyd-tcp.socket + + +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`` ``virtproxyd`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtproxyd.conf`` + +The default configuration file used by ``virtproxyd``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/libvirt-sock`` +* ``@RUNSTATEDIR@/libvirt/libvirt-sock-ro`` + +The sockets ``virtproxyd`` will use. + +* ``@SYSCONFDIR@/pki/CA/cacert.pem`` + +The TLS **Certificate Authority** certificate ``virtproxyd`` will use. + +* ``@SYSCONFDIR@/pki/libvirt/servercert.pem`` + +The TLS **Server** certificate ``virtproxyd`` will use. + +* ``@SYSCONFDIR@/pki/libvirt/private/serverkey.pem`` + +The TLS **Server** private key ``virtproxyd`` will use. + +* ``@RUNSTATEDIR@/virtproxyd.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtproxyd.conf`` + +The default configuration file used by ``virtproxyd``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/libvirt-sock`` + +The socket ``virtproxyd`` will use. + +* ``$HOME/.pki/libvirt/cacert.pem`` + +The TLS **Certificate Authority** certificate ``virtproxyd`` will use. + +* ``$HOME/.pki/libvirt/servercert.pem`` + +The TLS **Server** certificate ``virtproxyd`` will use. + +* ``$HOME/.pki/libvirt/serverkey.pem`` + +The TLS **Server** private key ``virtproxyd`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtproxyd.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtproxyd`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtproxyd`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtproxyd``: + +:: + + # virtproxyd --version + virtproxyd (libvirt) 6.6.0 + + +To start ``virtproxyd``, instructing it to daemonize and create a PID file: + +:: + + # virtproxyd -d + # ls -la @RUNSTATEDIR@/virtproxyd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtproxyd.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 +======= + +``virtproxyd`` 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>`_, -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 7 ++ docs/manpages/meson.build | 1 + docs/manpages/virtbhyved.rst | 193 +++++++++++++++++++++++++++++++++++ 3 files changed, 201 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..9fdaca6da2 --- /dev/null +++ b/docs/manpages/virtbhyved.rst @@ -0,0 +1,193 @@ +========== +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. + + +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.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtinterfaced.rst | 215 +++++++++++++++++++++++++++++++ 3 files changed, 217 insertions(+) create mode 100644 docs/manpages/virtinterfaced.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index da835d62ec..18153ac714 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -18,6 +18,7 @@ Modular Driver daemons These daemons provide functionality to a single libvirt driver * `virtbhyved(8) <virtbhyved.html>`__ - libvirt bhyve management daemon +* `virtinterfaced(8) <virtinterfaced.html>`__ - libvirt host network interface management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index 7c03cb74cf..a46f75d503 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -23,6 +23,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': 'virtinterfaced', 'section': '8', 'install': conf.has('WITH_INTERFACE') }, { '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/virtinterfaced.rst b/docs/manpages/virtinterfaced.rst new file mode 100644 index 0000000000..5777dba638 --- /dev/null +++ b/docs/manpages/virtinterfaced.rst @@ -0,0 +1,215 @@ +============== +virtinterfaced +============== + +------------------------------------------------ +libvirt host network interface management daemon +------------------------------------------------ + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtinterfaced`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtinterfaced`` 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 host network +interfaces. + +The ``virtinterfaced`` 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 ``virtinterfaced`` 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 ``virtinterfaced`` 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/virtinterfaced.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 virtinterfaced.socket virtinterfaced-ro.socket \ + virtinterfaced-admin.socket + + +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`` ``virtinterfaced`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtinterfaced.conf`` + +The default configuration file used by ``virtinterfaced``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtinterfaced-sock`` +* ``@RUNSTATEDIR@/libvirt/virtinterfaced-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtinterfaced-admin-sock`` + +The sockets ``virtinterfaced`` will use. + +The TLS **Server** private key ``virtinterfaced`` will use. + +* ``@RUNSTATEDIR@/virtinterfaced.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtinterfaced.conf`` + +The default configuration file used by ``virtinterfaced``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtinterfaced-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtinterfaced-admin-sock`` + +The sockets ``virtinterfaced`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtinterfaced.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtinterfaced`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtinterfaced`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtinterfaced``: + +:: + + # virtinterfaced --version + virtinterfaced (libvirt) @VERSION@ + + +To start ``virtinterfaced``, instructing it to daemonize and create a PID file: + +:: + + # virtinterfaced -d + # ls -la @RUNSTATEDIR@/virtinterfaced.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtinterfaced.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 +======= + +``virtinterfaced`` 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/drvinterface.html <https://www.libvirt.org/drvinterface.html>`_ -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtlxcd.rst | 215 +++++++++++++++++++++++++++++++++++++ 3 files changed, 217 insertions(+) create mode 100644 docs/manpages/virtlxcd.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 18153ac714..0eab1056e4 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -19,6 +19,7 @@ These daemons provide functionality to a single libvirt driver * `virtbhyved(8) <virtbhyved.html>`__ - libvirt bhyve management daemon * `virtinterfaced(8) <virtinterfaced.html>`__ - libvirt host network interface management daemon +* `virtlxcd(8) <virtlxcd.html>`__ - libvirt LXC management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index a46f75d503..083289642a 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -26,6 +26,7 @@ docs_man_files = [ { 'name': 'virtinterfaced', 'section': '8', 'install': conf.has('WITH_INTERFACE') }, { 'name': 'virtlockd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, { 'name': 'virtlogd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, + { 'name': 'virtlxcd', 'section': '8', 'install': conf.has('WITH_LXC') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, ] diff --git a/docs/manpages/virtlxcd.rst b/docs/manpages/virtlxcd.rst new file mode 100644 index 0000000000..f89d70ba21 --- /dev/null +++ b/docs/manpages/virtlxcd.rst @@ -0,0 +1,215 @@ +======== +virtlxcd +======== + +------------------------------ +libvirt LXC management daemon +------------------------------ + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtlxcd`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtlxcd`` 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 LXC +containers. + +The ``virtlxcd`` 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 ``virtlxcd`` 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 ``virtlxcd`` 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/virtlxcd.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 virtlxcd.socket virtlxcd-ro.socket \ + virtlxcd-admin.socket + + +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`` ``virtlxcd`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtlxcd.conf`` + +The default configuration file used by ``virtlxcd``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtlxcd-sock`` +* ``@RUNSTATEDIR@/libvirt/virtlxcd-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtlxcd-admin-sock`` + +The sockets ``virtlxcd`` will use. + +The TLS **Server** private key ``virtlxcd`` will use. + +* ``@RUNSTATEDIR@/virtlxcd.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtlxcd.conf`` + +The default configuration file used by ``virtlxcd``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtlxcd-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtlxcd-admin-sock`` + +The sockets ``virtlxcd`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtlxcd.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtlxcd`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtlxcd`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtlxcd``: + +:: + + # virtlxcd --version + virtlxcd (libvirt) @VERSION@ + + +To start ``virtlxcd``, instructing it to daemonize and create a PID file: + +:: + + # virtlxcd -d + # ls -la @RUNSTATEDIR@/virtlxcd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtlxcd.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 +======= + +``virtlxcd`` 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/drvlxc.html <https://www.libvirt.org/drvlxc.html>`_ -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtnetworkd.rst | 215 +++++++++++++++++++++++++++++++++ 3 files changed, 217 insertions(+) create mode 100644 docs/manpages/virtnetworkd.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 0eab1056e4..2ce222f952 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -20,6 +20,7 @@ These daemons provide functionality to a single libvirt driver * `virtbhyved(8) <virtbhyved.html>`__ - libvirt bhyve management daemon * `virtinterfaced(8) <virtinterfaced.html>`__ - libvirt host network interface management daemon * `virtlxcd(8) <virtlxcd.html>`__ - libvirt LXC management daemon +* `virtnetworkd(8) <virtnetworkd.html>`__ - libvirt virtual network management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index 083289642a..4c294909ee 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -27,6 +27,7 @@ docs_man_files = [ { 'name': 'virtlockd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, { 'name': 'virtlogd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, { 'name': 'virtlxcd', 'section': '8', 'install': conf.has('WITH_LXC') }, + { 'name': 'virtnetworkd', 'section': '8', 'install': conf.has('WITH_NETWORK') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, ] diff --git a/docs/manpages/virtnetworkd.rst b/docs/manpages/virtnetworkd.rst new file mode 100644 index 0000000000..1ef9a12210 --- /dev/null +++ b/docs/manpages/virtnetworkd.rst @@ -0,0 +1,215 @@ +============ +virtnetworkd +============ + +----------------------------------------- +libvirt virtual network management daemon +----------------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtnetworkd`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtnetworkd`` 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 virtual +networks. + +The ``virtnetworkd`` 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 ``virtnetworkd`` 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 ``virtnetworkd`` 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/virtnetworkd.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 virtnetworkd.socket virtnetworkd-ro.socket \ + virtnetworkd-admin.socket + + +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`` ``virtnetworkd`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtnetworkd.conf`` + +The default configuration file used by ``virtnetworkd``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtnetworkd-sock`` +* ``@RUNSTATEDIR@/libvirt/virtnetworkd-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtnetworkd-admin-sock`` + +The sockets ``virtnetworkd`` will use. + +The TLS **Server** private key ``virtnetworkd`` will use. + +* ``@RUNSTATEDIR@/virtnetworkd.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtnetworkd.conf`` + +The default configuration file used by ``virtnetworkd``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtnetworkd-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtnetworkd-admin-sock`` + +The sockets ``virtnetworkd`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtnetworkd.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtnetworkd`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtnetworkd`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtnetworkd``: + +:: + + # virtnetworkd --version + virtnetworkd (libvirt) @ + + +To start ``virtnetworkd``, instructing it to daemonize and create a PID file: + +:: + + # virtnetworkd -d + # ls -la @RUNSTATEDIR@/virtnetworkd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtnetworkd.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 +======= + +``virtnetworkd`` 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/drvnetwork.html <https://www.libvirt.org/drvnetwork.html>`_ -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtnodedevd.rst | 214 +++++++++++++++++++++++++++++++++ 3 files changed, 216 insertions(+) create mode 100644 docs/manpages/virtnodedevd.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 2ce222f952..5e87870f4b 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -21,6 +21,7 @@ These daemons provide functionality to a single libvirt driver * `virtinterfaced(8) <virtinterfaced.html>`__ - libvirt host network interface management daemon * `virtlxcd(8) <virtlxcd.html>`__ - libvirt LXC management daemon * `virtnetworkd(8) <virtnetworkd.html>`__ - libvirt virtual network management daemon +* `virtnodedevd(8) <virtnodedevd.html>`__ - libvirt host device management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index 4c294909ee..85f45410a0 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -28,6 +28,7 @@ docs_man_files = [ { 'name': 'virtlogd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, { 'name': 'virtlxcd', 'section': '8', 'install': conf.has('WITH_LXC') }, { 'name': 'virtnetworkd', 'section': '8', 'install': conf.has('WITH_NETWORK') }, + { 'name': 'virtnodedevd', 'section': '8', 'install': conf.has('WITH_NODE_DEVICES') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, ] diff --git a/docs/manpages/virtnodedevd.rst b/docs/manpages/virtnodedevd.rst new file mode 100644 index 0000000000..a29c0dbc9e --- /dev/null +++ b/docs/manpages/virtnodedevd.rst @@ -0,0 +1,214 @@ +============ +virtnodedevd +============ + +------------------------------------- +libvirt host device management daemon +------------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtnodedevd`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtnodedevd`` 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 host devices. + +The ``virtnodedevd`` 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 ``virtnodedevd`` 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 ``virtnodedevd`` 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/virtnodedevd.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 virtnodedevd.socket virtnodedevd-ro.socket \ + virtnodedevd-admin.socket + + +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`` ``virtnodedevd`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtnodedevd.conf`` + +The default configuration file used by ``virtnodedevd``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtnodedevd-sock`` +* ``@RUNSTATEDIR@/libvirt/virtnodedevd-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtnodedevd-admin-sock`` + +The sockets ``virtnodedevd`` will use. + +The TLS **Server** private key ``virtnodedevd`` will use. + +* ``@RUNSTATEDIR@/virtnodedevd.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtnodedevd.conf`` + +The default configuration file used by ``virtnodedevd``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtnodedevd-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtnodedevd-admin-sock`` + +The sockets ``virtnodedevd`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtnodedevd.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtnodedevd`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtnodedevd`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtnodedevd``: + +:: + + # virtnodedevd --version + virtnodedevd (libvirt) @ + + +To start ``virtnodedevd``, instructing it to daemonize and create a PID file: + +:: + + # virtnodedevd -d + # ls -la @RUNSTATEDIR@/virtnodedevd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtnodedevd.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 +======= + +``virtnodedevd`` 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/drvnodedev.html <https://www.libvirt.org/drvnodedev.html>`_ -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtnwfilterd.rst | 215 ++++++++++++++++++++++++++++++++ 3 files changed, 217 insertions(+) create mode 100644 docs/manpages/virtnwfilterd.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 5e87870f4b..e70b560a0d 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -22,6 +22,7 @@ These daemons provide functionality to a single libvirt driver * `virtlxcd(8) <virtlxcd.html>`__ - libvirt LXC management daemon * `virtnetworkd(8) <virtnetworkd.html>`__ - libvirt virtual network management daemon * `virtnodedevd(8) <virtnodedevd.html>`__ - libvirt host device management daemon +* `virtnwfilterd(8) <virtnwfilterd.html>`__ - libvirt network filter management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index 85f45410a0..019accbca2 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -29,6 +29,7 @@ docs_man_files = [ { 'name': 'virtlxcd', 'section': '8', 'install': conf.has('WITH_LXC') }, { 'name': 'virtnetworkd', 'section': '8', 'install': conf.has('WITH_NETWORK') }, { 'name': 'virtnodedevd', 'section': '8', 'install': conf.has('WITH_NODE_DEVICES') }, + { 'name': 'virtnwfilterd', 'section': '8', 'install': conf.has('WITH_NWFILTER') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, ] diff --git a/docs/manpages/virtnwfilterd.rst b/docs/manpages/virtnwfilterd.rst new file mode 100644 index 0000000000..47cca7e282 --- /dev/null +++ b/docs/manpages/virtnwfilterd.rst @@ -0,0 +1,215 @@ +============= +virtnwfilterd +============= + +---------------------------------------- +libvirt network filter management daemon +---------------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtnwfilterd`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtnwfilterd`` 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 network +filters. + +The ``virtnwfilterd`` 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 ``virtnwfilterd`` 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 ``virtnwfilterd`` 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/virtnwfilterd.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 virtnwfilterd.socket virtnwfilterd-ro.socket \ + virtnwfilterd-admin.socket + + +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`` ``virtnwfilterd`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtnwfilterd.conf`` + +The default configuration file used by ``virtnwfilterd``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtnwfilterd-sock`` +* ``@RUNSTATEDIR@/libvirt/virtnwfilterd-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtnwfilterd-admin-sock`` + +The sockets ``virtnwfilterd`` will use. + +The TLS **Server** private key ``virtnwfilterd`` will use. + +* ``@RUNSTATEDIR@/virtnwfilterd.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtnwfilterd.conf`` + +The default configuration file used by ``virtnwfilterd``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtnwfilterd-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtnwfilterd-admin-sock`` + +The sockets ``virtnwfilterd`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtnwfilterd.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtnwfilterd`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtnwfilterd`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtnwfilterd``: + +:: + + # virtnwfilterd --version + virtnwfilterd (libvirt) @ + + +To start ``virtnwfilterd``, instructing it to daemonize and create a PID file: + +:: + + # virtnwfilterd -d + # ls -la @RUNSTATEDIR@/virtnwfilterd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtnwfilterd.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 +======= + +``virtnwfilterd`` 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/drvnwfilter.html <https://www.libvirt.org/drvnwfilter.html>`_ -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtqemud.rst | 215 ++++++++++++++++++++++++++++++++++++ 3 files changed, 217 insertions(+) create mode 100644 docs/manpages/virtqemud.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index e70b560a0d..67357419eb 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -23,6 +23,7 @@ These daemons provide functionality to a single libvirt driver * `virtnetworkd(8) <virtnetworkd.html>`__ - libvirt virtual network management daemon * `virtnodedevd(8) <virtnodedevd.html>`__ - libvirt host device management daemon * `virtnwfilterd(8) <virtnwfilterd.html>`__ - libvirt network filter management daemon +* `virtqemud(8) <virtqemud.html>`__ - libvirt QEMU management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index 019accbca2..e08365b780 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -31,6 +31,7 @@ docs_man_files = [ { 'name': 'virtnodedevd', 'section': '8', 'install': conf.has('WITH_NODE_DEVICES') }, { 'name': 'virtnwfilterd', 'section': '8', 'install': conf.has('WITH_NWFILTER') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, + { 'name': 'virtqemud', 'section': '8', 'install': conf.has('WITH_QEMU') }, ] foreach name : keycode_list diff --git a/docs/manpages/virtqemud.rst b/docs/manpages/virtqemud.rst new file mode 100644 index 0000000000..78a032caa1 --- /dev/null +++ b/docs/manpages/virtqemud.rst @@ -0,0 +1,215 @@ +========= +virtqemud +========= + +------------------------------ +libvirt QEMU management daemon +------------------------------ + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtqemud`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtqemud`` 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 QEMU virtual +machines. + +The ``virtqemud`` 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 ``virtqemud`` 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 ``virtqemud`` 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/virtqemud.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 virtqemud.socket virtqemud-ro.socket \ + virtqemud-admin.socket + + +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`` ``virtqemud`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtqemud.conf`` + +The default configuration file used by ``virtqemud``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtqemud-sock`` +* ``@RUNSTATEDIR@/libvirt/virtqemud-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtqemud-admin-sock`` + +The sockets ``virtqemud`` will use. + +The TLS **Server** private key ``virtqemud`` will use. + +* ``@RUNSTATEDIR@/virtqemud.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtqemud.conf`` + +The default configuration file used by ``virtqemud``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtqemud-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtqemud-admin-sock`` + +The sockets ``virtqemud`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtqemud.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtqemud`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtqemud`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtqemud``: + +:: + + # virtqemud --version + virtqemud (libvirt) 0.8.2 + + +To start ``virtqemud``, instructing it to daemonize and create a PID file: + +:: + + # virtqemud -d + # ls -la @RUNSTATEDIR@/virtqemud.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtqemud.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 +======= + +``virtqemud`` 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/drvqemu.html <https://www.libvirt.org/drvqemu.html>`_ -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtsecretd.rst | 214 ++++++++++++++++++++++++++++++++++ 3 files changed, 216 insertions(+) create mode 100644 docs/manpages/virtsecretd.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 67357419eb..fb62dc86a2 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -24,6 +24,7 @@ These daemons provide functionality to a single libvirt driver * `virtnodedevd(8) <virtnodedevd.html>`__ - libvirt host device management daemon * `virtnwfilterd(8) <virtnwfilterd.html>`__ - libvirt network filter management daemon * `virtqemud(8) <virtqemud.html>`__ - libvirt QEMU management daemon +* `virtsecretd(8) <virtsecretd.html>`__ - libvirt secret data management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index e08365b780..1476722bde 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -32,6 +32,7 @@ docs_man_files = [ { 'name': 'virtnwfilterd', 'section': '8', 'install': conf.has('WITH_NWFILTER') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, { 'name': 'virtqemud', 'section': '8', 'install': conf.has('WITH_QEMU') }, + { 'name': 'virtsecretd', 'section': '8', 'install': conf.has('WITH_SECRETS') }, ] foreach name : keycode_list diff --git a/docs/manpages/virtsecretd.rst b/docs/manpages/virtsecretd.rst new file mode 100644 index 0000000000..2fa01ef147 --- /dev/null +++ b/docs/manpages/virtsecretd.rst @@ -0,0 +1,214 @@ +=========== +virtsecretd +=========== + +------------------------------------- +libvirt secret data management daemon +------------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtsecretd`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtsecretd`` 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 secret data. + +The ``virtsecretd`` 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 ``virtsecretd`` 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 ``virtsecretd`` 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/virtsecretd.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 virtsecretd.socket virtsecretd-ro.socket \ + virtsecretd-admin.socket + + +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`` ``virtsecretd`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtsecretd.conf`` + +The default configuration file used by ``virtsecretd``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtsecretd-sock`` +* ``@RUNSTATEDIR@/libvirt/virtsecretd-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtsecretd-admin-sock`` + +The sockets ``virtsecretd`` will use. + +The TLS **Server** private key ``virtsecretd`` will use. + +* ``@RUNSTATEDIR@/virtsecretd.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtsecretd.conf`` + +The default configuration file used by ``virtsecretd``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtsecretd-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtsecretd-admin-sock`` + +The sockets ``virtsecretd`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtsecretd.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtsecretd`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtsecretd`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtsecretd``: + +:: + + # virtsecretd --version + virtsecretd (libvirt) @ + + +To start ``virtsecretd``, instructing it to daemonize and create a PID file: + +:: + + # virtsecretd -d + # ls -la @RUNSTATEDIR@/virtsecretd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtsecretd.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 +======= + +``virtsecretd`` 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/drvsecret.html <https://www.libvirt.org/drvsecret.html>`_ -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtstoraged.rst | 215 +++++++++++++++++++++++++++++++++ 3 files changed, 217 insertions(+) create mode 100644 docs/manpages/virtstoraged.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index fb62dc86a2..40f1fb849f 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -25,6 +25,7 @@ These daemons provide functionality to a single libvirt driver * `virtnwfilterd(8) <virtnwfilterd.html>`__ - libvirt network filter management daemon * `virtqemud(8) <virtqemud.html>`__ - libvirt QEMU management daemon * `virtsecretd(8) <virtsecretd.html>`__ - libvirt secret data management daemon +* `virtstoraged(8) <virtstoraged.html>`__ - libvirt storage pool management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index 1476722bde..9bc61c56cd 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -33,6 +33,7 @@ docs_man_files = [ { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, { 'name': 'virtqemud', 'section': '8', 'install': conf.has('WITH_QEMU') }, { 'name': 'virtsecretd', 'section': '8', 'install': conf.has('WITH_SECRETS') }, + { 'name': 'virtstoraged', 'section': '8', 'install': conf.has('WITH_STORAGE') }, ] foreach name : keycode_list diff --git a/docs/manpages/virtstoraged.rst b/docs/manpages/virtstoraged.rst new file mode 100644 index 0000000000..1ca0b394bc --- /dev/null +++ b/docs/manpages/virtstoraged.rst @@ -0,0 +1,215 @@ +============ +virtstoraged +============ + +-------------------------------------- +libvirt storage pool management daemon +-------------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtstoraged`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtstoraged`` 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 storage +pools. + +The ``virtstoraged`` 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 ``virtstoraged`` 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 ``virtstoraged`` 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/virtstoraged.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 virtstoraged.socket virtstoraged-ro.socket \ + virtstoraged-admin.socket + + +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`` ``virtstoraged`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtstoraged.conf`` + +The default configuration file used by ``virtstoraged``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtstoraged-sock`` +* ``@RUNSTATEDIR@/libvirt/virtstoraged-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtstoraged-admin-sock`` + +The sockets ``virtstoraged`` will use. + +The TLS **Server** private key ``virtstoraged`` will use. + +* ``@RUNSTATEDIR@/virtstoraged.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtstoraged.conf`` + +The default configuration file used by ``virtstoraged``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtstoraged-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtstoraged-admin-sock`` + +The sockets ``virtstoraged`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtstoraged.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtstoraged`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtstoraged`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtstoraged``: + +:: + + # virtstoraged --version + virtstoraged (libvirt) @ + + +To start ``virtstoraged``, instructing it to daemonize and create a PID file: + +:: + + # virtstoraged -d + # ls -la @RUNSTATEDIR@/virtstoraged.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtstoraged.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 +======= + +``virtstoraged`` 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/drvstorage.html <https://www.libvirt.org/drvstorage.html>`_ -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtvboxd.rst | 213 ++++++++++++++++++++++++++++++++++++ 3 files changed, 215 insertions(+) create mode 100644 docs/manpages/virtvboxd.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 40f1fb849f..fa983c6cbd 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -26,6 +26,7 @@ These daemons provide functionality to a single libvirt driver * `virtqemud(8) <virtqemud.html>`__ - libvirt QEMU management daemon * `virtsecretd(8) <virtsecretd.html>`__ - libvirt secret data management daemon * `virtstoraged(8) <virtstoraged.html>`__ - libvirt storage pool management daemon +* `virtvboxd(8) <virtvboxd.html>`__ - libvirt VirtualBox management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index 9bc61c56cd..af10d3a2c5 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -34,6 +34,7 @@ docs_man_files = [ { 'name': 'virtqemud', 'section': '8', 'install': conf.has('WITH_QEMU') }, { 'name': 'virtsecretd', 'section': '8', 'install': conf.has('WITH_SECRETS') }, { 'name': 'virtstoraged', 'section': '8', 'install': conf.has('WITH_STORAGE') }, + { 'name': 'virtvboxd', 'section': '8', 'install': conf.has('WITH_VBOX') }, ] foreach name : keycode_list diff --git a/docs/manpages/virtvboxd.rst b/docs/manpages/virtvboxd.rst new file mode 100644 index 0000000000..d452766b3e --- /dev/null +++ b/docs/manpages/virtvboxd.rst @@ -0,0 +1,213 @@ +========= +virtvboxd +========= + +------------------------------------ +libvirt VirtualBox management daemon +------------------------------------ + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtvboxd`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtvboxd`` 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 VirtualBox +virtual machines. + +The ``virtvboxd`` 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 ``virtvboxd`` does not interrupt running guests. Guests continue to +operate and changes in their state will generally be picked up automatically +during startup. + +SYSTEM SOCKET ACTIVATION +======================== + +The ``virtvboxd`` 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/virtvboxd.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 virtvboxd.socket virtvboxd-ro.socket \ + virtvboxd-admin.socket + + +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`` ``virtvboxd`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtvboxd.conf`` + +The default configuration file used by ``virtvboxd``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtvboxd-sock`` +* ``@RUNSTATEDIR@/libvirt/virtvboxd-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtvboxd-admin-sock`` + +The sockets ``virtvboxd`` will use. + +The TLS **Server** private key ``virtvboxd`` will use. + +* ``@RUNSTATEDIR@/virtvboxd.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtvboxd.conf`` + +The default configuration file used by ``virtvboxd``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtvboxd-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtvboxd-admin-sock`` + +The sockets ``virtvboxd`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtvboxd.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtvboxd`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtvboxd`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtvboxd``: + +:: + + # virtvboxd --version + virtvboxd (libvirt) @ + + +To start ``virtvboxd``, instructing it to daemonize and create a PID file: + +:: + + # virtvboxd -d + # ls -la @RUNSTATEDIR@/virtvboxd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtvboxd.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 +======= + +``virtvboxd`` 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/drvvbox.html <https://www.libvirt.org/drvvbox.html>`_ -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtvzd.rst | 215 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 217 insertions(+) create mode 100644 docs/manpages/virtvzd.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index fa983c6cbd..4e351722a5 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -27,6 +27,7 @@ These daemons provide functionality to a single libvirt driver * `virtsecretd(8) <virtsecretd.html>`__ - libvirt secret data management daemon * `virtstoraged(8) <virtstoraged.html>`__ - libvirt storage pool management daemon * `virtvboxd(8) <virtvboxd.html>`__ - libvirt VirtualBox management daemon +* `virtvzd(8) <virtvzd.html>`__ - libvirt Virtuozzo management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index af10d3a2c5..9c3431c95c 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -35,6 +35,7 @@ docs_man_files = [ { 'name': 'virtsecretd', 'section': '8', 'install': conf.has('WITH_SECRETS') }, { 'name': 'virtstoraged', 'section': '8', 'install': conf.has('WITH_STORAGE') }, { 'name': 'virtvboxd', 'section': '8', 'install': conf.has('WITH_VBOX') }, + { 'name': 'virtvzd', 'section': '8', 'install': conf.has('WITH_VZ') }, ] foreach name : keycode_list diff --git a/docs/manpages/virtvzd.rst b/docs/manpages/virtvzd.rst new file mode 100644 index 0000000000..7e776026f8 --- /dev/null +++ b/docs/manpages/virtvzd.rst @@ -0,0 +1,215 @@ +======= +virtvzd +======= + +----------------------------------- +libvirt Virtuozzo management daemon +----------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtvzd`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtvzd`` 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 Virtuozzo +virtual machines. + +The ``virtvzd`` 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 ``virtvzd`` 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 ``virtvzd`` 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/virtvzd.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 virtvzd.socket virtvzd-ro.socket \ + virtvzd-admin.socket + + +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`` ``virtvzd`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtvzd.conf`` + +The default configuration file used by ``virtvzd``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtvzd-sock`` +* ``@RUNSTATEDIR@/libvirt/virtvzd-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtvzd-admin-sock`` + +The sockets ``virtvzd`` will use. + +The TLS **Server** private key ``virtvzd`` will use. + +* ``@RUNSTATEDIR@/virtvzd.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtvzd.conf`` + +The default configuration file used by ``virtvzd``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtvzd-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtvzd-admin-sock`` + +The sockets ``virtvzd`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtvzd.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtvzd`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtvzd`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtvzd``: + +:: + + # virtvzd --version + virtvzd (libvirt) @ + + +To start ``virtvzd``, instructing it to daemonize and create a PID file: + +:: + + # virtvzd -d + # ls -la @RUNSTATEDIR@/virtvzd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtvzd.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 +======= + +``virtvzd`` 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/drvvz.html <https://www.libvirt.org/drvvz.html>`_ -- 2.29.2

This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/manpages/index.rst | 1 + docs/manpages/meson.build | 1 + docs/manpages/virtxend.rst | 215 +++++++++++++++++++++++++++++++++++++ 3 files changed, 217 insertions(+) create mode 100644 docs/manpages/virtxend.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 4e351722a5..fb4a36d46a 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -28,6 +28,7 @@ These daemons provide functionality to a single libvirt driver * `virtstoraged(8) <virtstoraged.html>`__ - libvirt storage pool management daemon * `virtvboxd(8) <virtvboxd.html>`__ - libvirt VirtualBox management daemon * `virtvzd(8) <virtvzd.html>`__ - libvirt Virtuozzo management daemon +* `virtxend(8) <virtxend.html>`__ - libvirt Xen management daemon Tools ===== diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index 9c3431c95c..800c3692fb 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -36,6 +36,7 @@ docs_man_files = [ { 'name': 'virtstoraged', 'section': '8', 'install': conf.has('WITH_STORAGE') }, { 'name': 'virtvboxd', 'section': '8', 'install': conf.has('WITH_VBOX') }, { 'name': 'virtvzd', 'section': '8', 'install': conf.has('WITH_VZ') }, + { 'name': 'virtxend', 'section': '8', 'install': conf.has('WITH_XEN') }, ] foreach name : keycode_list diff --git a/docs/manpages/virtxend.rst b/docs/manpages/virtxend.rst new file mode 100644 index 0000000000..cf0128d3ff --- /dev/null +++ b/docs/manpages/virtxend.rst @@ -0,0 +1,215 @@ +======== +virtxend +======== + +----------------------------- +libvirt Xen management daemon +----------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +======== + +``virtxend`` [*OPTION*]... + + +DESCRIPTION +=========== + +The ``virtxend`` 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 Xen virtual +machines. + +The ``virtxend`` 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 ``virtxend`` 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 ``virtxend`` 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/virtxend.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 virtxend.socket virtxend-ro.socket \ + virtxend-admin.socket + + +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`` ``virtxend`` will reload its configuration. + + +FILES +===== + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtxend.conf`` + +The default configuration file used by ``virtxend``, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``@RUNSTATEDIR@/libvirt/virtxend-sock`` +* ``@RUNSTATEDIR@/libvirt/virtxend-sock-ro`` +* ``@RUNSTATEDIR@/libvirt/virtxend-admin-sock`` + +The sockets ``virtxend`` will use. + +The TLS **Server** private key ``virtxend`` will use. + +* ``@RUNSTATEDIR@/virtxend.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` option. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtxend.conf`` + +The default configuration file used by ``virtxend``, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/virtxend-sock`` +* ``$XDG_RUNTIME_DIR/libvirt/virtxend-admin-sock`` + +The sockets ``virtxend`` will use. + +* ``$XDG_RUNTIME_DIR/libvirt/virtxend.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, ``virtxend`` will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtxend`` will use +``$HOME/.cache`` + + +EXAMPLES +======== + +To retrieve the version of ``virtxend``: + +:: + + # virtxend --version + virtxend (libvirt) @ + + +To start ``virtxend``, instructing it to daemonize and create a PID file: + +:: + + # virtxend -d + # ls -la @RUNSTATEDIR@/virtxend.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtxend.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 +======= + +``virtxend`` 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/drvxen.html <https://www.libvirt.org/drvxen.html>`_ -- 2.29.2