External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-07-12 12:55:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
bc54376f09
libvirt/docs/manpages/virtproxyd.rst

259 lines
5.9 KiB
ReStructuredText
Raw Normal View History

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>
2020-09-24 14:08:37 +00:00
==========
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.
Fix spelling Signed-off-by: Tim Wiederhake <twiederh@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Ján Tomko <jtomko@redhat.com>
2021-04-15 08:12:12 +00:00
Since ``virtproxyd`` merely forwards RPC messages, it has no important state,
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>
2020-09-24 14:08:37 +00:00
and can be restarted at any time. Clients should expect to reconnect after
the restart.
docs: Do not support non-socket activated modular daemons with systemd Due to the setup of the modular daemon service files the reverting to non-socket activated daemons could have never worked. The reason is that masking the socket files prevents starting the daemons since they require (as in Requires= rather than Wants= in the service file) the sockets. On top of that it creates issues with some libvirt-guests setups and needlessly increases our support matrix. Nothing prevents users to modify their setup in a way that will still work without socket activation, but supporting such setup only creates burden on our part. This technically reverts most of commit 59d30adacd1d except the change made to the libvirtd manpage since the monolithic daemon still supports traditional mode of starting even on systemd. Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2022-10-18 12:15:38 +00:00
DAEMON STARTUP MODES
====================
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>
2020-09-24 14:08:37 +00:00
The ``virtproxyd`` daemon is capable of starting in two modes.
docs: Do not support non-socket activated modular daemons with systemd Due to the setup of the modular daemon service files the reverting to non-socket activated daemons could have never worked. The reason is that masking the socket files prevents starting the daemons since they require (as in Requires= rather than Wants= in the service file) the sockets. On top of that it creates issues with some libvirt-guests setups and needlessly increases our support matrix. Nothing prevents users to modify their setup in a way that will still work without socket activation, but supporting such setup only creates burden on our part. This technically reverts most of commit 59d30adacd1d except the change made to the libvirtd manpage since the monolithic daemon still supports traditional mode of starting even on systemd. Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2022-10-18 12:15:38 +00:00
Socket activation mode
----------------------
On hosts with systemd it is started in socket activation mode and 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
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>
2020-09-24 14:08:37 +00:00
::
$ systemctl start virtproxyd-tls.socket
Or
::
$ systemctl start virtproxyd-tcp.socket
docs: manpages: State that TCP connection is insecure in 'virtproxyd' man page Copy the wording we have in docs/uri.rst Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2023-04-20 08:59:57 +00:00
**Note**: The TCP socket uses plain unencrypted TCP connection and thus is
insecure and should not be used.
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>
2020-09-24 14:08:37 +00:00
docs: Do not support non-socket activated modular daemons with systemd Due to the setup of the modular daemon service files the reverting to non-socket activated daemons could have never worked. The reason is that masking the socket files prevents starting the daemons since they require (as in Requires= rather than Wants= in the service file) the sockets. On top of that it creates issues with some libvirt-guests setups and needlessly increases our support matrix. Nothing prevents users to modify their setup in a way that will still work without socket activation, but supporting such setup only creates burden on our part. This technically reverts most of commit 59d30adacd1d except the change made to the libvirtd manpage since the monolithic daemon still supports traditional mode of starting even on systemd. Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2022-10-18 12:15:38 +00:00
Traditional service mode
------------------------
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>
2020-09-24 14:08:37 +00:00
docs: Do not support non-socket activated modular daemons with systemd Due to the setup of the modular daemon service files the reverting to non-socket activated daemons could have never worked. The reason is that masking the socket files prevents starting the daemons since they require (as in Requires= rather than Wants= in the service file) the sockets. On top of that it creates issues with some libvirt-guests setups and needlessly increases our support matrix. Nothing prevents users to modify their setup in a way that will still work without socket activation, but supporting such setup only creates burden on our part. This technically reverts most of commit 59d30adacd1d except the change made to the libvirtd manpage since the monolithic daemon still supports traditional mode of starting even on systemd. Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
2022-10-18 12:15:38 +00:00
On hosts without systemd, 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``
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>
2020-09-24 14:08:37 +00:00
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*``
docs: clarify --timeout description for split daemons Remove the reference to "running domains" for daemons that happily exit while domains are running. https://bugzilla.redhat.com/show_bug.cgi?id=2035985 Signed-off-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Andrea Bolognani <abologna@redhat.com>
2023-03-15 10:08:29 +00:00
Exit after timeout period (in seconds), provided there are no client
connections.
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>
2020-09-24 14:08:37 +00:00
``-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),
Use 'libvirt.org' instead of 'www.libvirt.org' Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2023-03-14 14:39:22 +00:00
`https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
Reference in New Issue Copy Permalink