mirror of https://gitee.com/openkylin/libvirt.git
docs: add manpage for virtproxyd
This is an adaptation of the libvirtd manpage. Reviewed-by: Jiri Denemark <jdenemar@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Daniel P. Berrangé
parent
a992496e91
commit
081dd65148
|
|
@ -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
|
||||
=====
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 and
|
||||
|
||||
* 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) @VERSION@
|
||||
|
||||
|
||||
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>`_,
|
||||
|
|
@ -1580,6 +1580,7 @@ exit 0
|
|||
%{_mandir}/man8/libvirtd.8*
|
||||
%{_mandir}/man8/virtlogd.8*
|
||||
%{_mandir}/man8/virtlockd.8*
|
||||
%{_mandir}/man8/virtproxyd.8*
|
||||
%{_mandir}/man7/virkey*.7*
|
||||
|
||||
%files daemon-config-network
|
||||
|
|
|
|||
Loading…
Reference in New Issue