From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867574; cv=none; d=zohomail.com; s=zohoarc; b=WmDgDTWyX/4yNt4hhKU7luI5NW7gsMTUt3XblJmgf68sjpNgU7vUvtwxbPDCZ80wAIt+eE9tvzINN236qA3UiOpPsrE53DufANSfVpXAKpKT6UykWZXNZD95Oc+sJhA6mYff0aV0DDBsc+dqRiw75IoIISFxz3g082zIUPVCF4M= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867574; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=gw4PwUiTaDQ5lQX4WuC1c+mE8NT7bX7zCiTrQ38dHDg=; b=eV9e3uVJu3h7L8ThNdJ15ZDxp8vu8cHTsDdooAxBahqHMDHkgycjNgTuEEK7XBb7fhhm2jptRy2us9HS0vW980d8NI6HBmx0QSZGlsA7NKtcV7sUHxlcTb1TF+GctURACkG2s7spS2IIdP2ouxmlpzubA3O3YPqYSCT1ws9KuqI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 1609867574604399.90749883686703; Tue, 5 Jan 2021 09:26:14 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-181-ej1P6ckeOeqX9e1-RFiCCw-1; Tue, 05 Jan 2021 12:26:11 -0500 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 00727180A094; Tue, 5 Jan 2021 17:26:05 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id CE19A7092C; Tue, 5 Jan 2021 17:26:04 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 6682F4BB7B; Tue, 5 Jan 2021 17:26:04 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQ1AH032281 for ; Tue, 5 Jan 2021 12:26:01 -0500 Received: by smtp.corp.redhat.com (Postfix) id 09D8B60C0F; Tue, 5 Jan 2021 17:26:01 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id 33B2860BE5; Tue, 5 Jan 2021 17:26:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867573; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=gw4PwUiTaDQ5lQX4WuC1c+mE8NT7bX7zCiTrQ38dHDg=; b=N3nOjBw5U6lLTDEcbJ1MCth5099CWbPOYe5izzqg6SC0zkz3DSitYBygJM0kXIfLYF4TZq HhfgGuZiqe1F36bSwPKzfZP4w0Pcss0osxh2HhCutilFxbQ7yMBmpAPR7YSDm/kQzyI0dx paCvpjXvmZ4K5orkzz6WrpIf3zNZMTM= X-MC-Unique: ej1P6ckeOeqX9e1-RFiCCw-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 01/16] docs: consistently mark libvirtd as preformatted text Date: Tue, 5 Jan 2021 17:25:39 +0000 Message-Id: <20210105172554.943968-2-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 t= his daemon to issue tasks and collect information about the configuration and resources of the= host system and guests. =20 -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 s= ocket -to use is defined in the libvirtd configuration file. +By default, the ``libvirtd`` daemon listens for requests on a local Unix d= omain +socket. Using the ``-l`` | ``--listen`` command line option, the ``libvir= td`` +daemon can be instructed to additionally listen on a TCP/IP socket. The T= CP/IP +socket to use is defined in the ``libvirtd`` configuration file. =20 -Restarting libvirtd does not impact running guests. Guests continue to op= erate -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. =20 @@ -98,8 +98,8 @@ Use this configuration file, overriding the default value. ``-l``, ``--listen`` =20 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. =20 ``-p``, ``--pid-file *FILE*`` =20 @@ -122,7 +122,7 @@ Display version information then exit. SIGNALS =3D=3D=3D=3D=3D=3D=3D =20 -On receipt of ``SIGHUP`` libvirtd will reload its configuration. +On receipt of ``SIGHUP`` ``libvirtd`` will reload its configuration. =20 =20 FILES @@ -133,25 +133,25 @@ When run as *root* =20 * ``@SYSCONFDIR@/libvirt/libvirtd.conf`` =20 -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. =20 * ``@RUNSTATEDIR@/libvirt/libvirt-sock`` * ``@RUNSTATEDIR@/libvirt/libvirt-sock-ro`` =20 -The sockets libvirtd will use. +The sockets ``libvirtd`` will use. =20 * ``@SYSCONFDIR@/pki/CA/cacert.pem`` =20 -The TLS **Certificate Authority** certificate libvirtd will use. +The TLS **Certificate Authority** certificate ``libvirtd`` will use. =20 * ``@SYSCONFDIR@/pki/libvirt/servercert.pem`` =20 -The TLS **Server** certificate libvirtd will use. +The TLS **Server** certificate ``libvirtd`` will use. =20 * ``@SYSCONFDIR@/pki/libvirt/private/serverkey.pem`` =20 -The TLS **Server** private key libvirtd will use. +The TLS **Server** private key ``libvirtd`` will use. =20 * ``@RUNSTATEDIR@/libvirtd.pid`` =20 @@ -163,41 +163,41 @@ When run as *non-root* =20 * ``$XDG_CONFIG_HOME/libvirt/libvirtd.conf`` =20 -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. =20 * ``$XDG_RUNTIME_DIR/libvirt/libvirt-sock`` =20 -The socket libvirtd will use. +The socket ``libvirtd`` will use. =20 * ``$HOME/.pki/libvirt/cacert.pem`` =20 -The TLS **Certificate Authority** certificate libvirtd will use. +The TLS **Certificate Authority** certificate ``libvirtd`` will use. =20 * ``$HOME/.pki/libvirt/servercert.pem`` =20 -The TLS **Server** certificate libvirtd will use. +The TLS **Server** certificate ``libvirtd`` will use. =20 * ``$HOME/.pki/libvirt/serverkey.pem`` =20 -The TLS **Server** private key libvirtd will use. +The TLS **Server** private key ``libvirtd`` will use. =20 * ``$XDG_RUNTIME_DIR/libvirt/libvirtd.pid`` =20 The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. =20 =20 -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`` =20 -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`` =20 =20 EXAMPLES =3D=3D=3D=3D=3D=3D=3D=3D =20 -To retrieve the version of libvirtd: +To retrieve the version of ``libvirtd``: =20 :: =20 @@ -205,7 +205,7 @@ To retrieve the version of libvirtd: libvirtd (libvirt) 0.8.2 =20 =20 -To start libvirtd, instructing it to daemonize and create a PID file: +To start ``libvirtd``, instructing it to daemonize and create a PID file: =20 :: =20 @@ -246,7 +246,7 @@ libvirt AUTHORS file. LICENSE =3D=3D=3D=3D=3D=3D=3D =20 -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 --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867624; cv=none; d=zohomail.com; s=zohoarc; b=mEu20RJxPBpFns+KTUkgGW6uHk46/PbMcXH3icGLSQAXBqKAvXNyocG9qLMMYnde4tO7BqyZPE3eAXH1gJ5iBT2fNGJLp5XnxZZpL1SeaWm3xnG/M1cIOp7KHj/PmJ4muIbYCnCV0LijF7lQF3TRmSIENdBnFLNpLSIqgrsxL4Q= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867624; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=007wTQR3RmASqgjwgGyTNAuaPmc+3OC6HH1mXLlELMQ=; b=D3HI8OJs/D09JvXXwgZWGwGIX4E/iqld79OhOz53CrCKI9gD3Yz+04w0PN26ruoesSB4o9JuI8nf4hKKKSIYZvM4IBBnEHS7qGJtx9KOzZOaum4rQeWeOR1cGH+LyWof4Ugl82DqGTXSDcX0vNR+z+OKu9NoOuaE/7b6g+LOCFM= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 1609867624185483.72640780126403; Tue, 5 Jan 2021 09:27:04 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-272-9ISVTaiuNV2FL3Bvu0Zb_w-1; Tue, 05 Jan 2021 12:26:17 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id C8BBF804006; Tue, 5 Jan 2021 17:26:11 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 547B260BFA; Tue, 5 Jan 2021 17:26:11 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 1D5625002E; Tue, 5 Jan 2021 17:26:11 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQ5RN032297 for ; Tue, 5 Jan 2021 12:26:05 -0500 Received: by smtp.corp.redhat.com (Postfix) id E0FE960C04; Tue, 5 Jan 2021 17:26:05 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0D38E60BFA; Tue, 5 Jan 2021 17:26:01 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867623; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=007wTQR3RmASqgjwgGyTNAuaPmc+3OC6HH1mXLlELMQ=; b=NXZFz1vgh1dv+8uEq3q5WpO0Eb+g5xadXBmHB2GCxVRduFeJ49qQd77jdWyoeixG8Tvdxi ml/Al68KX/IFfpZiFmDV+5bql5ArFfflSnJqg3Sv30YPXJf00NqzAswrQEv+AeWw41zwYr dwPq0mzaB319HP0miZ1xUK/vzlPEym8= X-MC-Unique: 9ISVTaiuNV2FL3Bvu0Zb_w-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 02/16] docs: don't hardcode an ancient version in manpage examples Date: Tue, 5 Jan 2021 17:25:40 +0000 Message-Id: <20210105172554.943968-3-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Subsitute in the current version so the example always reflect today's version of reality. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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``: :: =20 # libvirtd --version - libvirtd (libvirt) 0.8.2 + libvirtd (libvirt) @VERSION@ =20 =20 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 =3D configuration_data() docs_man_conf.set('SYSCONFDIR', sysconfdir) docs_man_conf.set('RUNSTATEDIR', runstatedir) +docs_man_conf.set('VERSION', meson.project_version()) =20 foreach data : docs_man_files rst_in_file =3D '@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``: :: =20 # virtlockd --version - virtlockd (libvirt) 1.1.1 + virtlockd (libvirt) @VERSION@ =20 To start ``virtlockd``, instructing it to daemonize and create a PID file: =20 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``: :: =20 # virtlogd --version - virtlogd (libvirt) 1.1.1 + virtlogd (libvirt) @VERSION@ =20 To start ``virtlogd``, instructing it to daemonize and create a PID file: =20 --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) client-ip=63.128.21.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867585; cv=none; d=zohomail.com; s=zohoarc; b=ixmMc8p9eMUkuZCDeYOCJYEXu3oU2FGrgOtvnaHgUfSCrJu1XxYT3kckU5geJ01+zeG1AQlmPOjpMxOBxry269M7HbmD47+iZD/+eXgxlBIbt9Qy1KDdELv7euozkXMBW92qCk0vl/StMGnwGH+rHWHO+5j8dmm9NwflWo5ZvdY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867585; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=Nh2gcZIdm1AHlIwbB1CSebXKR9QwDXJwBSO7skTldXg=; b=O/ygJq7CVcOXk/pEMUdmMPTrgPd/OKZAukACxdM0k/Vzt5KIbCuH50Nm8qxgY+Nngr9BGIK7MoXMsgxDL4DQr7nmAgGVpl2JdC93Hz6r0p5GftN6tdY/Lb4FFX14flJe0suI8SwidhpNDLLchUIZhobnz62pSTZoqj9y/UTK8uk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by mx.zohomail.com with SMTPS id 1609867585643120.68856824148429; Tue, 5 Jan 2021 09:26:25 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-18-pLioXvppOOKxj6tvspVAhQ-1; Tue, 05 Jan 2021 12:26:19 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 32FFA80400D; Tue, 5 Jan 2021 17:26:13 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 10BF960BFA; Tue, 5 Jan 2021 17:26:13 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id CA2101809CA1; Tue, 5 Jan 2021 17:26:12 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQ7Hm032306 for ; Tue, 5 Jan 2021 12:26:07 -0500 Received: by smtp.corp.redhat.com (Postfix) id 4BDBC60C04; Tue, 5 Jan 2021 17:26:07 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4126460BE5; Tue, 5 Jan 2021 17:26:06 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867584; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=Nh2gcZIdm1AHlIwbB1CSebXKR9QwDXJwBSO7skTldXg=; b=f4pr3tq7n+yjjGtHQXHV0eu7DNddQ00GDUCz0SDoPTmv/2IpAPWjKSuy02kEmuHOoIkCR5 EFfR9OmDBrCyZsPsIH9M896Cb/Zkxy8BWAhJKkVHdQnu5O4Xam3r+sSEx/ojTK+uVQl7F2 ewKAYo6t+UYSkChRhV5QfJIeYvIMpRs= X-MC-Unique: pLioXvppOOKxj6tvspVAhQ-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 03/16] docs: tweak heading for daemon manual pages Date: Tue, 5 Jan 2021 17:25:41 +0000 Message-Id: <20210105172554.943968-4-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This group will be distinct from the per-driver modular daemon mapages. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -Daemons -=3D=3D=3D=3D=3D=3D=3D +Common Daemons +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +These daemons provide functionality across multiple libvirt drivers =20 * `libvirtd(8) `__ - libvirt management daemon * `virtlockd(8) `__ - libvirt lock management daemon --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867589; cv=none; d=zohomail.com; s=zohoarc; b=VCXUjTnEbdeo8lFFPgUdYEnMDDuzWmQ9Ta4Ferws53Aa5id0wO34QsmhK5ErGvPYMugS4E2LEVUmqePk+ol3UiBIi+Nn30dQ9Fie8BbnSF+28rUNZS/EtVJbCbzfWIHWZFAdazyibbh0PuDnNimmhfbnPKwK2HdLZTIL80izznM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867589; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=zhAQ9aWsihKDtPIKFwuouo1Cz5eLm0fyuCEdWvgyWAQ=; b=KRIqsUher0cRXrFKFcIM9ssuzr5ipDWS3wLGu/4DNhFXqcNJSZ0r9IcXv+JRhReXGVxMAMho9RB9zv1HJnowWmIkhzLoWl9U0IMmh+bBi1wMJYLShnK3MY7RVzSgu/o62vNJVIVSnYhXq00gXGwVdDGqhWCeovR5vI8C5S4Gjug= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 1609867589215868.3194277460614; Tue, 5 Jan 2021 09:26:29 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-593-c7NUCGg8N7KZRZsIUl4ohg-1; Tue, 05 Jan 2021 12:26:24 -0500 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id DDF3B180A09E; Tue, 5 Jan 2021 17:26:15 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id BBBF270946; Tue, 5 Jan 2021 17:26:15 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 83DD31809CA5; Tue, 5 Jan 2021 17:26:15 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQ8gN032313 for ; Tue, 5 Jan 2021 12:26:08 -0500 Received: by smtp.corp.redhat.com (Postfix) id 818D060BFA; Tue, 5 Jan 2021 17:26:08 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id C043F60BE5; Tue, 5 Jan 2021 17:26:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867588; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=zhAQ9aWsihKDtPIKFwuouo1Cz5eLm0fyuCEdWvgyWAQ=; b=eyiAbDpBhDKQrD4qsGFRkROL+eQoJO/6FyjHjyHoofrZjP1+zftxPrJ5RtT6044eOBE6du jJDt2r6SQs+PCGV/2gkaanX4bPQMXH4raPLGSonL6cJTgxwtHR6V4Oztt5Y3hiVXdyHQgw gEzf7MkuIXeKsxSqHh2z0ubWn3JqVvc= X-MC-Unique: c7NUCGg8N7KZRZsIUl4ohg-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 04/16] docs: add manpage for virtproxyd Date: Tue, 5 Jan 2021 17:25:42 +0000 Message-Id: <20210105172554.943968-5-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 libvi= rt drivers * `libvirtd(8) `__ - libvirt management daemon * `virtlockd(8) `__ - libvirt lock management daemon * `virtlogd(8) `__ - libvirt log management daemon +* `virtproxyd(8) `__ - libvirt proxy daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'virt-sanlock-cleanup', 'section': '8', 'install': conf.has('W= ITH_SANLOCK') }, { 'name': 'virtlockd', 'section': '8', 'install': conf.has('WITH_LIBVIRT= D') }, { 'name': 'virtlogd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD= ') }, + { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIR= TD') }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +virtproxyd +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +-------------------- +libvirt proxy daemon +-------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtproxyd`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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-ope= ned +listener sockets on startup. + +Since ``virtproxyd`` merely forwards RPC mesages, it has no important stat= e, +and can be restarted at any time. Clients should expect to reconnect after +the restart. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtproxyd`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtproxyd.conf`` + +The default configuration file used by ``virtproxyd``, unless overridden o= n 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`` opti= on. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtproxyd.conf`` + +The default configuration file used by ``virtproxyd``, unless overridden o= n 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`` wil= l use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtproxyd`` wil= l use +``$HOME/.cache`` + + +EXAMPLES +=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) client-ip=63.128.21.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867584; cv=none; d=zohomail.com; s=zohoarc; b=nfl1hjWVxgGShQlJq2+Ssx1Fh3zALxzXOYt8u1x4qINabbMM8Qgwvl3TS43C8N7oP+J333S0ZWXzPWaxMNJ9iVMc0G/YDE3tS2sqQ6ViKZrEChSIcngGoYDrDBrA71QXx7euW7GizgARnrbQDkV6S5hlFEfyGOSrjB+5u5IA/as= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867584; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=4ozioAuFja8Q7grK6po+xwzwAYlImX3lKfGSsUHxGXY=; b=kELfr/9gwOke41oKq5NE/cy80Klz1xIKw3Sf/fiu6UOu9PrRKSy1sF+jUW+t5VhoexofyaQ3oydOpLJtHeiuwI7IoFay6x2Z/C1l1QML67R9hyAsXrf1jZH5t83BIWNEC41yziQRWsJopNmbjqViAL8QhAEdrxEmXlSS0QGf83I= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by mx.zohomail.com with SMTPS id 1609867584701904.5825931219432; Tue, 5 Jan 2021 09:26:24 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-202-Z6ucV028PziDa4QQOPo7KA-1; Tue, 05 Jan 2021 12:26:17 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 89C12107ACE8; Tue, 5 Jan 2021 17:26:11 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 670E270464; Tue, 5 Jan 2021 17:26:11 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 2E5FE5002D; Tue, 5 Jan 2021 17:26:11 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQ9Wp032323 for ; Tue, 5 Jan 2021 12:26:09 -0500 Received: by smtp.corp.redhat.com (Postfix) id CE2F060BFA; Tue, 5 Jan 2021 17:26:09 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id EAE3E60BE5; Tue, 5 Jan 2021 17:26:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867583; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=4ozioAuFja8Q7grK6po+xwzwAYlImX3lKfGSsUHxGXY=; b=DGHL2yB1eZh+SIjBLU/ps87nzGA8HMEWJejr6ZrJLRstj8lDKpThmmOFvuqNhDNWnvAf5l TYAUjmy+cdzCKrCyvNNg21yOjw+glkPVe/6OjuHgUKJrWJdcd+9C89dAuwwGrJdLN0LlCC +BPAG17RKSYsBj/88UhDAPN7JT3twCs= X-MC-Unique: Z6ucV028PziDa4QQOPo7KA-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 05/16] docs: add manpage for virtbhyved Date: Tue, 5 Jan 2021 17:25:43 +0000 Message-Id: <20210105172554.943968-6-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 libv= irt drivers * `virtlogd(8) `__ - libvirt log management daemon * `virtproxyd(8) `__ - libvirt proxy daemon =20 +Modular Driver daemons +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +These daemons provide functionality to a single libvirt driver + +* `virtbhyved(8) `__ - libvirt bhyve management daemon + Tools =3D=3D=3D=3D=3D =20 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 =3D [ =20 { 'name': 'libvirtd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD= ') }, { 'name': 'virt-sanlock-cleanup', 'section': '8', 'install': conf.has('W= ITH_SANLOCK') }, + { 'name': 'virtbhyved', 'section': '8', 'install': conf.has('WITH_BHYVE'= ) }, { 'name': 'virtlockd', 'section': '8', 'install': conf.has('WITH_LIBVIRT= D') }, { 'name': 'virtlogd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD= ') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIR= TD') }, 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +virtbhyved +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +------------------------------- +libvirt bhyve management daemon +------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtbhyved`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 v= irtual +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 contin= ue to +operate and changes in their state will generally be picked up automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +OPTIONS +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtbhyved`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtbhyved.conf`` + +The default configuration file used by ``virtbhyved``, unless overridden o= n 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`` opti= on. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtbhyved.conf`` + +The default configuration file used by ``virtbhyved``, unless overridden o= n 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`` wil= l use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtbhyved`` wil= l use +``$HOME/.cache`` + + +EXAMPLES +=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvbhyve.html `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867594; cv=none; d=zohomail.com; s=zohoarc; b=bpLJw4Z2Q+HRTFOltqqXJmua+hwHyzvvCnibZj3weqlxYqYKmXMI+z9aqzQHscgZGwwAIkqWrG4JlzfEkTFzDa4QVRGqVCDG1RTjY9sjdEeGpcB88r+K5lANj3V2+eHQ5rcoeHs9DMbaO7INFawu4VxLmkhh3PSaP/AquKWjPz8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867594; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=HA5wOuOgXHBYQXPGprFGWKKaWrXiOM8BbjF4Q9MGBzk=; b=eyapL07WvlpFwL8jnrWOtdxNbBNP2FCKFEh+yGMHFihIjkWiT3TiQGoOYdC31t017Y1qQJKrFO0c9N7T5NMEBYnpqINKkZiOSmBkwVjGixt9G1tCHST8yEkNbtS15TKnDFFefXTkrmseRftup/zYqejlA2i9ibGn0ryDgDefhqk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 160986759401597.71580529746154; Tue, 5 Jan 2021 09:26:34 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-371-bb0lUxSxOvexQxHNy2UKkA-1; Tue, 05 Jan 2021 12:26:28 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 888B21005513; Tue, 5 Jan 2021 17:26:19 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 395216267B; Tue, 5 Jan 2021 17:26:19 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 040DF50035; Tue, 5 Jan 2021 17:26:19 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQBFb032339 for ; Tue, 5 Jan 2021 12:26:11 -0500 Received: by smtp.corp.redhat.com (Postfix) id 784C060C0F; Tue, 5 Jan 2021 17:26:11 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id A2B2760BE5; Tue, 5 Jan 2021 17:26:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867593; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=HA5wOuOgXHBYQXPGprFGWKKaWrXiOM8BbjF4Q9MGBzk=; b=M1K88eD3Ngif+k9QI85+swhR8aBD/jWp9HzgOLxNOcvfbrnxZ30G2vZfXy/PvHXLVScUa4 FvTHhq0RDtUI3CvvKyvxdFvv/eHYmrm/e81Pe1NreEZrUS9FLd5nxOxjje0m4o6P8FjrjU 09nX/Hl7FW7Sng0h8E+sYENlzTyZIdU= X-MC-Unique: bb0lUxSxOvexQxHNy2UKkA-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 06/16] docs: add manpage for virtinterfaced Date: Tue, 5 Jan 2021 17:25:44 +0000 Message-Id: <20210105172554.943968-7-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 =20 * `virtbhyved(8) `__ - libvirt bhyve management daemon +* `virtinterfaced(8) `__ - libvirt host network inter= face management daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'libvirtd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD= ') }, { 'name': 'virt-sanlock-cleanup', 'section': '8', 'install': conf.has('W= ITH_SANLOCK') }, { 'name': 'virtbhyved', 'section': '8', 'install': conf.has('WITH_BHYVE'= ) }, + { 'name': 'virtinterfaced', 'section': '8', 'install': conf.has('WITH_IN= TERFACE') }, { 'name': 'virtlockd', 'section': '8', 'install': conf.has('WITH_LIBVIRT= D') }, { 'name': 'virtlogd', 'section': '8', 'install': conf.has('WITH_LIBVIRTD= ') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIR= TD') }, diff --git a/docs/manpages/virtinterfaced.rst b/docs/manpages/virtinterface= d.rst new file mode 100644 index 0000000000..5777dba638 --- /dev/null +++ b/docs/manpages/virtinterfaced.rst @@ -0,0 +1,215 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +virtinterfaced +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +------------------------------------------------ +libvirt host network interface management daemon +------------------------------------------------ + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtinterfaced`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The ``virtinterfaced`` program is a server side daemon component of the li= bvirt +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 ne= twork +interfaces. + +The ``virtinterfaced`` daemon only listens for requests on a local Unix do= main +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 co= ntinue to +operate and changes in their state will generally be picked up automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtinterfaced`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtinterfaced.conf`` + +The default configuration file used by ``virtinterfaced``, unless overridd= en 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`` opti= on. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtinterfaced.conf`` + +The default configuration file used by ``virtinterfaced``, unless overridd= en 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 +=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvinterface.html `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867593; cv=none; d=zohomail.com; s=zohoarc; b=KdkGUiSRMSVNoamCbVNPBKZitvHyLx7nujbAHyqAqKI41x4biDPLK7rSwEWzluDqS0Bd1NDNaELGFeoacfbIVWSh1A2gPPSPOnMUHDpoDxN9CQyFRiwwxRqWs+DS2oowNtE+ID4/lvEaV2V5CjPnrYGnksUMN1fXYguq2CJfhjY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867593; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=/3P9KfHnl3VmatMcWzZfa8F+NcrvoZS54F2kXLNuG4Q=; b=h8XQMvL/ywlsrN80p5dXYoALvwYMvw6P21QKc4VQI1RKj4jEfvqgVJoLamaU/sjtiHm+9tnYMS2GDIFmfjU3+ZkQaGWEAKr0496ZW9NcjalDH5okNu9/6wcFzqHZUzE8tR5ikaoTOV8prZkDUy4hjSsDITIPQDW424q4jl9Frig= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 1609867593335187.0621004261127; Tue, 5 Jan 2021 09:26:33 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-487-00Nn0nCVMmStC7Qi_CE-4Q-1; Tue, 05 Jan 2021 12:26:29 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 23A61804006; Tue, 5 Jan 2021 17:26:22 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id F121C60BFA; Tue, 5 Jan 2021 17:26:21 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id BABE31809CAA; Tue, 5 Jan 2021 17:26:21 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQCNk032350 for ; Tue, 5 Jan 2021 12:26:12 -0500 Received: by smtp.corp.redhat.com (Postfix) id ADD7060BFA; Tue, 5 Jan 2021 17:26:12 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id D702D60BE5; Tue, 5 Jan 2021 17:26:11 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867592; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=/3P9KfHnl3VmatMcWzZfa8F+NcrvoZS54F2kXLNuG4Q=; b=JKOr7fThITNAeQaQB2/Xes5CFfBSTcdZ3HEfrSxe0NDDW8bLhSyIQQkLuAM9v8NVXnbckC Y8ITg44Doy7+OyWF3N6bzeE2cR4ZRgI67NZtfqgITrCno2GgPfpkOHjWUwwPqaPkoj+wvV P+0wyP2ibM8jaO67AcKcyCf9EVV0mTc= X-MC-Unique: 00Nn0nCVMmStC7Qi_CE-4Q-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 07/16] docs: add manpage for virtlxcd Date: Tue, 5 Jan 2021 17:25:45 +0000 Message-Id: <20210105172554.943968-8-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 d= river =20 * `virtbhyved(8) `__ - libvirt bhyve management daemon * `virtinterfaced(8) `__ - libvirt host network inter= face management daemon +* `virtlxcd(8) `__ - libvirt LXC management daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'virtinterfaced', 'section': '8', 'install': conf.has('WITH_IN= TERFACE') }, { 'name': 'virtlockd', 'section': '8', 'install': conf.has('WITH_LIBVIRT= D') }, { '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_LIBVIR= TD') }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D +virtlxcd +=3D=3D=3D=3D=3D=3D=3D=3D + +------------------------------ +libvirt LXC management daemon +------------------------------ + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtlxcd`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtlxcd`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +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`` opti= on. + + +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 +=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvlxc.html = `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) client-ip=63.128.21.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867591; cv=none; d=zohomail.com; s=zohoarc; b=N0xek373yJh63eqvqyzQeAEMFX2H1Q1JCvEFxusFwBghdyQFFFNN8F6PkOgaxaWCeahN988M6LxBREjvPB8cPUtr8NJgwSoAZopI2kELgRLnPenT0m24n//MXsh2BXxdJHw3VlUGS0MkH8cT5uhtp6rUUaFK3qDS2oEMozsiWs8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867591; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=zpYiMkFcWCHTr0J3GcEiPmRDzJoTdf0WuQl+TyBvC1Y=; b=Mu9jt8z+FGX67g1I8ekT575V9pKKciIotS1pyJzyrUPwN4xbeE06jjnxAB/Dbx5H93W1/PG3NC+b4B+C3RI6Ouk+VPIOpB6iBDtD/0uElNqfp44Bxp3rEauz+DUP7Fqa+FUjMzNDyZaGY+BdX2tgvkcQQpUWu2od5AFaI3iBldE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by mx.zohomail.com with SMTPS id 1609867591411108.28334818943438; Tue, 5 Jan 2021 09:26:31 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-186-cJpwmcTkOiG4GiGmZAAnog-1; Tue, 05 Jan 2021 12:26:27 -0500 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 4D003180A099; Tue, 5 Jan 2021 17:26:15 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 2162A272BB; Tue, 5 Jan 2021 17:26:15 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id DB9F01809CA2; Tue, 5 Jan 2021 17:26:14 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQDUa032358 for ; Tue, 5 Jan 2021 12:26:13 -0500 Received: by smtp.corp.redhat.com (Postfix) id E5A8E60BE5; Tue, 5 Jan 2021 17:26:13 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1F17260C04; Tue, 5 Jan 2021 17:26:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867590; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=zpYiMkFcWCHTr0J3GcEiPmRDzJoTdf0WuQl+TyBvC1Y=; b=epCRWfl1Nld4Peogh6BaeQnf88M3+ipu3TOBu4GWoBkvnsprKXS964o/dVByIH2Q8j3jrF SK53hPT3VTCRan+WW0KZ0OveveNJrznFUcPU1TeWPjWZtczPKWmTscRddJ9LKIJo2t2IDK PkeBRR3DAQQlhRh8LDVhuytM/JMEHWY= X-MC-Unique: cJpwmcTkOiG4GiGmZAAnog-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 08/16] docs: add manpage for virtnetworkd Date: Tue, 5 Jan 2021 17:25:46 +0000 Message-Id: <20210105172554.943968-9-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 d= river * `virtbhyved(8) `__ - libvirt bhyve management daemon * `virtinterfaced(8) `__ - libvirt host network inter= face management daemon * `virtlxcd(8) `__ - libvirt LXC management daemon +* `virtnetworkd(8) `__ - libvirt virtual network manage= ment daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'virtlockd', 'section': '8', 'install': conf.has('WITH_LIBVIRT= D') }, { '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_NETW= ORK') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIR= TD') }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +virtnetworkd +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +----------------------------------------- +libvirt virtual network management daemon +----------------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtnetworkd`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The ``virtnetworkd`` program is a server side daemon component of the libv= irt +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 doma= in +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 cont= inue to +operate and changes in their state will generally be picked up automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtnetworkd`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +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`` opti= on. + + +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`` w= ill use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtnetworkd`` w= ill use +``$HOME/.cache`` + + +EXAMPLES +=3D=3D=3D=3D=3D=3D=3D=3D + +To retrieve the version of ``virtnetworkd``: + +:: + + # virtnetworkd --version + virtnetworkd (libvirt) @ + + +To start ``virtnetworkd``, instructing it to daemonize and create a PID fi= le: + +:: + + # virtnetworkd -d + # ls -la @RUNSTATEDIR@/virtnetworkd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtnetworkd.pid + + +BUGS +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvnetwork.html `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867594; cv=none; d=zohomail.com; s=zohoarc; b=MMJIE0i8jXrPrKdqMh4E/+raJKPX/GHT5D6ti5oWVXIC9WPIPJeQ/UHfmCmn306WBO5qQtPu1rH7RupZb8hw9tzTHzOWPyMMSgmDiDNkrh5bwGXuheio9On819uF5qz1SVrGq6tSBmApjMu5AOIsEH5TyIqi5Gscocxo6EZiw3E= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867594; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=iHcXuQtdLg+pH4SadLWR3icNO0F+YoqKqWgNcE91trM=; b=Tu8xMx3TMAKOete1hPBYYF9E+1B+AUPhOnB++n//vwVZsTJzEGgutPhA9oqvR8CFKipoq0nd18UnKS9wwwhAGt6Ohz3gg21sIvLGYLL4qBsN1pzzPjbCs6Xcf1ScJLAmgTqKTP6G3YhHRK/tLE+L6t+QSHdPqgg40yJY4VAyhj0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 1609867594009673.5607487894853; Tue, 5 Jan 2021 09:26:34 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-131-Sj45ineeOoezZPWbuUtsFA-1; Tue, 05 Jan 2021 12:26:29 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 3E66A804013; Tue, 5 Jan 2021 17:26:21 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 19C0C1002388; Tue, 5 Jan 2021 17:26:21 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id D8CFA1809CA7; Tue, 5 Jan 2021 17:26:20 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQJma032378 for ; Tue, 5 Jan 2021 12:26:19 -0500 Received: by smtp.corp.redhat.com (Postfix) id 4303260C04; Tue, 5 Jan 2021 17:26:19 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id 723EC60BE5; Tue, 5 Jan 2021 17:26:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867593; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=iHcXuQtdLg+pH4SadLWR3icNO0F+YoqKqWgNcE91trM=; b=JbCNWpFEKIl9Ydf+jz8sWvvB/itkBpVxm7GVSy3WQgscOHvL7xshT8jVjFVnIJrFW1RqkZ IlHS2VriU6Ic2T2XyUzVrNDL12wzmhtGVvbHh4DLGpHcmjTLKCFy9vAVNhHzoVCCcMS+Wx iNS92znSGeezKwv8M3FI+24+BYnSZ/8= X-MC-Unique: Sj45ineeOoezZPWbuUtsFA-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 09/16] docs: add manpage for virtnodedevd Date: Tue, 5 Jan 2021 17:25:47 +0000 Message-Id: <20210105172554.943968-10-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 d= river * `virtinterfaced(8) `__ - libvirt host network inter= face management daemon * `virtlxcd(8) `__ - libvirt LXC management daemon * `virtnetworkd(8) `__ - libvirt virtual network manage= ment daemon +* `virtnodedevd(8) `__ - libvirt host device management= daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { '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_NETW= ORK') }, + { 'name': 'virtnodedevd', 'section': '8', 'install': conf.has('WITH_NODE= _DEVICES') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIR= TD') }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +virtnodedevd +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +------------------------------------- +libvirt host device management daemon +------------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtnodedevd`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The ``virtnodedevd`` program is a server side daemon component of the libv= irt +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 de= vices. + +The ``virtnodedevd`` daemon only listens for requests on a local Unix doma= in +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 cont= inue to +operate and changes in their state will generally be picked up automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtnodedevd`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +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`` opti= on. + + +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`` w= ill use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtnodedevd`` w= ill use +``$HOME/.cache`` + + +EXAMPLES +=3D=3D=3D=3D=3D=3D=3D=3D + +To retrieve the version of ``virtnodedevd``: + +:: + + # virtnodedevd --version + virtnodedevd (libvirt) @ + + +To start ``virtnodedevd``, instructing it to daemonize and create a PID fi= le: + +:: + + # virtnodedevd -d + # ls -la @RUNSTATEDIR@/virtnodedevd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtnodedevd.pid + + +BUGS +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvnodedev.html `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) client-ip=63.128.21.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867596; cv=none; d=zohomail.com; s=zohoarc; b=nawOqXhwte7KiwwD/Ama9NZhA2P3AvNQDuxTUIGapp2KHnydaHI+nwNrYsMjUm/mNsdGsFh4Rc3UJR304eXgTFJ+Z+fo3rW1Yldhb6n0toIzZ+FriRVrbSyBh8DfQ16jW2XLnOmDg/wV7AG2oY5p7MoGRz7J3A3NzsDAUsFzIyo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867596; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=3Kf51lgUN6RU+2FDCZdAc6o3kQT6KQvKYDvednYky+s=; b=esEl1LY5c1l/HMz6moXED9rWOpj0UiKquVyLNdddyeHquX3Ee4vLmuDOSjI4rS+eShaFyltdrh7X/iezW0QeZp6vlwXmfZo9l9VHRY9EosHrznEZuKY4T5j+tjFkvwUYHPBXGJIJLzcH1MXrneG7qB6dis+7gzBUdcnodD9DuEI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by mx.zohomail.com with SMTPS id 1609867596198412.62898552024194; Tue, 5 Jan 2021 09:26:36 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-336-7UvrLLQnOjavWrfK2GVkdQ-1; Tue, 05 Jan 2021 12:26:32 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id EFCD0801817; Tue, 5 Jan 2021 17:26:24 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id CC4B01002391; Tue, 5 Jan 2021 17:26:24 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 95FF650037; Tue, 5 Jan 2021 17:26:24 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQKkt032393 for ; Tue, 5 Jan 2021 12:26:20 -0500 Received: by smtp.corp.redhat.com (Postfix) id 9206A60BFA; Tue, 5 Jan 2021 17:26:20 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id BC31860BE5; Tue, 5 Jan 2021 17:26:19 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867595; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=3Kf51lgUN6RU+2FDCZdAc6o3kQT6KQvKYDvednYky+s=; b=J5Fkw8LqPRaXpNpDIJf8Wc3GRfLP45sOTYGPk12yDTNkdRNbIMp2rgplZ7jyPswow4r1HJ wq51jIf/J0sMJb5HZUu5ZdJumDUJx7v4xnKigArGAU3bIYhqZmxlMdU5PJQWo0juL5NWeN aiPHSFH+KAoQDbVzZ77oJLp1vRObUwM= X-MC-Unique: 7UvrLLQnOjavWrfK2GVkdQ-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 10/16] docs: add manpage for virtnwfilterd Date: Tue, 5 Jan 2021 17:25:48 +0000 Message-Id: <20210105172554.943968-11-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 d= river * `virtlxcd(8) `__ - libvirt LXC management daemon * `virtnetworkd(8) `__ - libvirt virtual network manage= ment daemon * `virtnodedevd(8) `__ - libvirt host device management= daemon +* `virtnwfilterd(8) `__ - libvirt network filter manag= ement daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'virtlxcd', 'section': '8', 'install': conf.has('WITH_LXC') }, { 'name': 'virtnetworkd', 'section': '8', 'install': conf.has('WITH_NETW= ORK') }, { 'name': 'virtnodedevd', 'section': '8', 'install': conf.has('WITH_NODE= _DEVICES') }, + { 'name': 'virtnwfilterd', 'section': '8', 'install': conf.has('WITH_NWF= ILTER') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIR= TD') }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +virtnwfilterd +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +---------------------------------------- +libvirt network filter management daemon +---------------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtnwfilterd`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The ``virtnwfilterd`` program is a server side daemon component of the lib= virt +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 dom= ain +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 con= tinue to +operate and changes in their state will generally be picked up automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtnwfilterd`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtnwfilterd.conf`` + +The default configuration file used by ``virtnwfilterd``, unless overridde= n 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`` opti= on. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtnwfilterd.conf`` + +The default configuration file used by ``virtnwfilterd``, unless overridde= n 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 +=3D=3D=3D=3D=3D=3D=3D=3D + +To retrieve the version of ``virtnwfilterd``: + +:: + + # virtnwfilterd --version + virtnwfilterd (libvirt) @ + + +To start ``virtnwfilterd``, instructing it to daemonize and create a PID f= ile: + +:: + + # virtnwfilterd -d + # ls -la @RUNSTATEDIR@/virtnwfilterd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtnwfilterd.pid + + +BUGS +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvnwfilter.html `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867600; cv=none; d=zohomail.com; s=zohoarc; b=Ess0L3mEqRkZIy8G1bP/JOn5YqZYM8ddRe/c3kZiDI5mtVK3IRx59Si0FNEPcG1PdrN6FAKiqMgt3XdyNmqBm3zPp47MeHwdPCCtOy3Sc4UOGgzSFo2mzgAnMETV80sJUkeUknqUck9jL0Rwtob2yWkHL+abpUX1UJkBa+iNwZM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867600; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=bOa/BjEfjZ5htFUE+rwE9jEKhddYAeyOstIi+R5GN3U=; b=YiVJQv150HeDMy024bjcpd7WTIswwiD0qiIBTDRO5gIMlxhgSUW6Lfr13/tpg/Lk3lN7Y1YzAecOrjy5o+seUPAAMK2BSXUmcoXyKT2BrQ1HopzaPZZeT5b2vS5NXTuqBT0ADgwinwrmc32c06GxIJq2vkSJSsarHADIyGK3vlw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 1609867600040466.8836356779009; Tue, 5 Jan 2021 09:26:40 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-5-qnJAnjmKN1i9ICAKXcFzIw-1; Tue, 05 Jan 2021 12:26:35 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id BC946107ACF6; Tue, 5 Jan 2021 17:26:27 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 9835B5D9D2; Tue, 5 Jan 2021 17:26:27 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 623741809CAC; Tue, 5 Jan 2021 17:26:27 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQMW0032406 for ; Tue, 5 Jan 2021 12:26:22 -0500 Received: by smtp.corp.redhat.com (Postfix) id 228E660C04; Tue, 5 Jan 2021 17:26:22 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id F379E60BE5; Tue, 5 Jan 2021 17:26:20 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867599; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=bOa/BjEfjZ5htFUE+rwE9jEKhddYAeyOstIi+R5GN3U=; b=al+nJiMxGPVrfe+MSm5Jc83Bfi/nX9VYS4xnZdI6QXm3ahs7QU+c/z2L8SbG8KvAFNbcAd bss5O3W95UbsiCe9J0KT5di9UnaLCIq4xuGl2w+t//2eoZns8CF3wBZurRxqBJAYC8E3MW 5O8iKxKJ9fSnzqgr2mQ+xNC0HdoE9OA= X-MC-Unique: qnJAnjmKN1i9ICAKXcFzIw-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 11/16] docs: add manpage for virtqemud Date: Tue, 5 Jan 2021 17:25:49 +0000 Message-Id: <20210105172554.943968-12-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 d= river * `virtnetworkd(8) `__ - libvirt virtual network manage= ment daemon * `virtnodedevd(8) `__ - libvirt host device management= daemon * `virtnwfilterd(8) `__ - libvirt network filter manag= ement daemon +* `virtqemud(8) `__ - libvirt QEMU management daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'virtnodedevd', 'section': '8', 'install': conf.has('WITH_NODE= _DEVICES') }, { 'name': 'virtnwfilterd', 'section': '8', 'install': conf.has('WITH_NWF= ILTER') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIR= TD') }, + { 'name': 'virtqemud', 'section': '8', 'install': conf.has('WITH_QEMU') = }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D +virtqemud +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +------------------------------ +libvirt QEMU management daemon +------------------------------ + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtqemud`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 vi= rtual +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 continu= e to +operate and changes in their state will generally be picked up automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtqemud`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +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`` opti= on. + + +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 +=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvqemu.html `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) client-ip=63.128.21.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867598; cv=none; d=zohomail.com; s=zohoarc; b=KyEtaB5i0kLUlBO7uu24Kb3VDNhlWsBq4E4MKT9NLvGex9gaHN3w5nccAkkL8M96xEaNK0AmIVhlA1M83d3BHE7/LYkshMfChol1gFIJZJN59FDUc3vmmoacqSMXuOzh9y9ytI6N6Jqmgfd896/EGLnqTEPWIMkrM8wNMSAX+HM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867598; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=YwqaOfo4payLwZ7Uk5f8CnZu6Q13wcRCojBTDQLvO4c=; b=fHkqWEbbe3TdoQFQeuh9IW8ghUCtsWCs9twL17/l9XgoK2ILpj0ZlenjHQhSPXJnsjjXByZavgkw0yUE36jGeHUd4Sq7LfvUkqpxN4JiJmYmwvv4qfNlx/o9yGrRttmoT3itqljlqSuIRuyGbdIVV5iJgHDBLkXBYJzPoKBTRM0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by mx.zohomail.com with SMTPS id 1609867598874767.0685392051212; Tue, 5 Jan 2021 09:26:38 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-90-b9VzNHb-OR2YnfPtJTklZQ-1; Tue, 05 Jan 2021 12:26:33 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id ED6CD9CC20; Tue, 5 Jan 2021 17:26:25 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id CD8E870464; Tue, 5 Jan 2021 17:26:25 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 986365003A; Tue, 5 Jan 2021 17:26:25 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQNkL032422 for ; Tue, 5 Jan 2021 12:26:23 -0500 Received: by smtp.corp.redhat.com (Postfix) id 5B0B860C0F; Tue, 5 Jan 2021 17:26:23 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id 8381760BE5; Tue, 5 Jan 2021 17:26:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867597; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=YwqaOfo4payLwZ7Uk5f8CnZu6Q13wcRCojBTDQLvO4c=; b=MeBxSRzFD3H20zg7cH64c7gsc5Ad9+qbMC+M79rOWbqva2+bHXVTQKsv395Hwyb6cS5Zcs ZO5HrI1SQyEYFToMQq9cUozuTppQX8hDCX9LZy/sYoBPsfms0E8rS1ax3t/NjOAJMLhpmj 31nksN4VkhdQlcR7uyYw1gOoZWBTMo8= X-MC-Unique: b9VzNHb-OR2YnfPtJTklZQ-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 12/16] docs: add manpage for virtsecretd Date: Tue, 5 Jan 2021 17:25:50 +0000 Message-Id: <20210105172554.943968-13-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 d= river * `virtnodedevd(8) `__ - libvirt host device management= daemon * `virtnwfilterd(8) `__ - libvirt network filter manag= ement daemon * `virtqemud(8) `__ - libvirt QEMU management daemon +* `virtsecretd(8) `__ - libvirt secret data management d= aemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'virtnwfilterd', 'section': '8', 'install': conf.has('WITH_NWF= ILTER') }, { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIR= TD') }, { 'name': 'virtqemud', 'section': '8', 'install': conf.has('WITH_QEMU') = }, + { 'name': 'virtsecretd', 'section': '8', 'install': conf.has('WITH_SECRE= TS') }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +virtsecretd +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +------------------------------------- +libvirt secret data management daemon +------------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtsecretd`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The ``virtsecretd`` program is a server side daemon component of the libvi= rt +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 conti= nue to +operate and changes in their state will generally be picked up automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtsecretd`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +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`` opti= on. + + +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`` wi= ll use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtsecretd`` wi= ll use +``$HOME/.cache`` + + +EXAMPLES +=3D=3D=3D=3D=3D=3D=3D=3D + +To retrieve the version of ``virtsecretd``: + +:: + + # virtsecretd --version + virtsecretd (libvirt) @ + + +To start ``virtsecretd``, instructing it to daemonize and create a PID fil= e: + +:: + + # virtsecretd -d + # ls -la @RUNSTATEDIR@/virtsecretd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtsecretd.pid + + +BUGS +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvsecret.html `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) client-ip=63.128.21.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867633; cv=none; d=zohomail.com; s=zohoarc; b=WHncFExT3Jv1FQM3DwQVUUXKW817meSmYrb1hZaXrXN78FX0kMQ9joGSPQNvGIirBhkxyM3CkEKZ6nHjmMO9odpAmRUEASneQDR00NjoYuKKxJJvDlo4Ws13JWeAFgEF6Ml4AY+VyuKBYZhm4HCW/TKO5NgNUk1iyH6/3O3uiVo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867633; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=0FHtmNdhAlwTuCMGgK3XCXsVQTJN8DG6OR8s3i+SvsY=; b=cfMqtL+9rqoWcW2QQlAjzbY1y+kEez56Q465l3wDCI0RENGlLh0OBAfVWBHFpd0pe54Mn4dQy4ppnjddT5tQHsxjpItmuyAzUnyhbKD43sjchr2OQYRUecT5rykYxcrmugPEC4PB2xb/cCv7i8I8wf4EHGgvIc9R9bM+X4LUuwQ= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by mx.zohomail.com with SMTPS id 1609867633368657.497161206198; Tue, 5 Jan 2021 09:27:13 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-532-bDPwjdpJM5-oWrKMoD3pjQ-1; Tue, 05 Jan 2021 12:26:36 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id C112A107ACF9; Tue, 5 Jan 2021 17:26:28 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 9EA1962677; Tue, 5 Jan 2021 17:26:28 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 6657F5003E; Tue, 5 Jan 2021 17:26:28 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQO8s032442 for ; Tue, 5 Jan 2021 12:26:24 -0500 Received: by smtp.corp.redhat.com (Postfix) id AD2D460C04; Tue, 5 Jan 2021 17:26:24 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id BAFD560BE5; Tue, 5 Jan 2021 17:26:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867632; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=0FHtmNdhAlwTuCMGgK3XCXsVQTJN8DG6OR8s3i+SvsY=; b=e4l6ypkkGK02L1xSdZvv2tnXFh4C9at+Bbf9Wh8dnE3GNFwWX26996PxhJa2T8mFX2OOqL EVzn5L7pmTJ30tCbkvecOQANBVVUVzr4+w1/lflMZ8fqV9u7sQhjPUKuaDfm+nStoQTg8u J2LcipOllk/wHdfZleddeYcuAcbZHmA= X-MC-Unique: bDPwjdpJM5-oWrKMoD3pjQ-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 13/16] docs: add manpage for virtstoraged Date: Tue, 5 Jan 2021 17:25:51 +0000 Message-Id: <20210105172554.943968-14-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 d= river * `virtnwfilterd(8) `__ - libvirt network filter manag= ement daemon * `virtqemud(8) `__ - libvirt QEMU management daemon * `virtsecretd(8) `__ - libvirt secret data management d= aemon +* `virtstoraged(8) `__ - libvirt storage pool managemen= t daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'virtproxyd', 'section': '8', 'install': conf.has('WITH_LIBVIR= TD') }, { 'name': 'virtqemud', 'section': '8', 'install': conf.has('WITH_QEMU') = }, { 'name': 'virtsecretd', 'section': '8', 'install': conf.has('WITH_SECRE= TS') }, + { 'name': 'virtstoraged', 'section': '8', 'install': conf.has('WITH_STOR= AGE') }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +virtstoraged +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +-------------------------------------- +libvirt storage pool management daemon +-------------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtstoraged`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The ``virtstoraged`` program is a server side daemon component of the libv= irt +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 doma= in +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 cont= inue to +operate and changes in their state will generally be picked up automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtstoraged`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +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`` opti= on. + + +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`` w= ill use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtstoraged`` w= ill use +``$HOME/.cache`` + + +EXAMPLES +=3D=3D=3D=3D=3D=3D=3D=3D + +To retrieve the version of ``virtstoraged``: + +:: + + # virtstoraged --version + virtstoraged (libvirt) @ + + +To start ``virtstoraged``, instructing it to daemonize and create a PID fi= le: + +:: + + # virtstoraged -d + # ls -la @RUNSTATEDIR@/virtstoraged.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtstoraged.pid + + +BUGS +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvstorage.html `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867635; cv=none; d=zohomail.com; s=zohoarc; b=N6yzVletF97kDmIGig8O5LK6zmDwgOB/okRJOdF7pB9DE9/wddFRGHtiK3KP6QOPEg0UMZttXOlasA639J97Ykf/mSv0UUgW54UKvQmVeTT5HEKxrdVhcH3XVQy4+YAInL0X4m27wk4sqdF+xRXt60aXKUOEhCt0IH5vSez+hFo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867635; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=xtbaHrzl9cYhx8yvK/amm9L2egRAY5m+axqSmE2eCKE=; b=mhAR3Z96s3LwGZ/aKopNIAs5+PTFLX21lAuQ14j5EojJu67aEMuHj5j5/3NXLXymwbZ4jp4aZEOtSMuy31NL2Q3OPFwIS3KVYOUB5Cr0LX66FchbUU16ALm6OqtJqTKNioo/AtyvynMMpLKnnMZV7E1rpoY/pNJCDT6mNbNo6eU= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 1609867635414565.9805676188316; Tue, 5 Jan 2021 09:27:15 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-427-i7pZTQmeP1eJerv4Isml3Q-1; Tue, 05 Jan 2021 12:26:38 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 9F655180A0A2; Tue, 5 Jan 2021 17:26:31 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 77DFF6F940; Tue, 5 Jan 2021 17:26:31 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 4161350042; Tue, 5 Jan 2021 17:26:31 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQQSB032457 for ; Tue, 5 Jan 2021 12:26:26 -0500 Received: by smtp.corp.redhat.com (Postfix) id 1820960BFA; Tue, 5 Jan 2021 17:26:26 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id 171E260BE5; Tue, 5 Jan 2021 17:26:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867634; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=xtbaHrzl9cYhx8yvK/amm9L2egRAY5m+axqSmE2eCKE=; b=L4m6xnIMmcdrjUGRDZ7dUx00rTJ7HveB30pHKohJG8qpoLVVROg1YYFgP8D6ReIdB1479V CQuvGk+f0nOkvYBZpNpHZqGcIkjWycymkMmzePl5J69pzR6tXLSXDhvzc4w3AJMZLDQZIe AVFnoqeidMhTLV9G4GuZhLcOTWasH40= X-MC-Unique: i7pZTQmeP1eJerv4Isml3Q-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 14/16] docs: add manpage for virtvboxd Date: Tue, 5 Jan 2021 17:25:52 +0000 Message-Id: <20210105172554.943968-15-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 d= river * `virtqemud(8) `__ - libvirt QEMU management daemon * `virtsecretd(8) `__ - libvirt secret data management d= aemon * `virtstoraged(8) `__ - libvirt storage pool managemen= t daemon +* `virtvboxd(8) `__ - libvirt VirtualBox management daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'virtqemud', 'section': '8', 'install': conf.has('WITH_QEMU') = }, { 'name': 'virtsecretd', 'section': '8', 'install': conf.has('WITH_SECRE= TS') }, { 'name': 'virtstoraged', 'section': '8', 'install': conf.has('WITH_STOR= AGE') }, + { 'name': 'virtvboxd', 'section': '8', 'install': conf.has('WITH_VBOX') = }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D +virtvboxd +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +------------------------------------ +libvirt VirtualBox management daemon +------------------------------------ + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtvboxd`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 Virtual= Box +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 continu= e to +operate and changes in their state will generally be picked up automatical= ly +during startup. + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtvboxd`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +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`` opti= on. + + +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 +=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvvbox.html `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867604; cv=none; d=zohomail.com; s=zohoarc; b=bFBOYZvo0Su8jYotdZ3ndMDYlewww2i2PEJDFxmY51C1yHqEGLgh5Mr4JjyUxC+NpL2/vW1w93BaaTxdjnGwku5dICXBzVAOPSfYe36yPNVA49Me+fDQPeg5JtWdtTTYf9nZgc8TOOSLno+6+8UHTY7wEf7m4L4PUGiCbehbpMs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867604; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=xZqgXrxytzK8dZ+dgH/sDJtt2jvv0dx5wLSNYpEPu/c=; b=gbTuLF9qcDLQd+VktlLaUTuloOm8C0eIt37zBah2EfJPLwDvKJyT/L2MjEhfv6OPINEzadf7XneMBFJ6NxLqIdmBSFD3f3UJSr3oXCNLzZSHwunpVPf0Fbv6v8TdjEupcmf68W1eT0eeNGiwLucfo1Kki8YDRPUX2+0PhkiyUUc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 1609867604559512.1785563014149; Tue, 5 Jan 2021 09:26:44 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-415-EVLjwpiJPR-sIDiIdWWbIQ-1; Tue, 05 Jan 2021 12:26:40 -0500 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 4E328180A09D; Tue, 5 Jan 2021 17:26:34 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 2D2A971C9B; Tue, 5 Jan 2021 17:26:34 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id EA5E450044; Tue, 5 Jan 2021 17:26:33 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQRNT032480 for ; Tue, 5 Jan 2021 12:26:27 -0500 Received: by smtp.corp.redhat.com (Postfix) id 4444760C0F; Tue, 5 Jan 2021 17:26:27 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id 8B51760BE5; Tue, 5 Jan 2021 17:26:26 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867603; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=xZqgXrxytzK8dZ+dgH/sDJtt2jvv0dx5wLSNYpEPu/c=; b=IBOXVLoWDolWi+e/AxIslQ4YO8CvdYx/JsF5KaFyEqYgUAK0muC3F+hH5y/j1wWcbkMqhm /IlT98j4Lu0fh9V7ZwXWlLdywOKm7kKDuMTdeT1oOPu02j3SH0nSHZGubuEqXOGgqL1IwV xmvjH/9WUbsFMZj8Ltivd7StfeztA84= X-MC-Unique: EVLjwpiJPR-sIDiIdWWbIQ-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 15/16] docs: add manpage for virtvzd Date: Tue, 5 Jan 2021 17:25:53 +0000 Message-Id: <20210105172554.943968-16-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 d= river * `virtsecretd(8) `__ - libvirt secret data management d= aemon * `virtstoraged(8) `__ - libvirt storage pool managemen= t daemon * `virtvboxd(8) `__ - libvirt VirtualBox management daemon +* `virtvzd(8) `__ - libvirt Virtuozzo management daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'virtsecretd', 'section': '8', 'install': conf.has('WITH_SECRE= TS') }, { 'name': 'virtstoraged', 'section': '8', 'install': conf.has('WITH_STOR= AGE') }, { 'name': 'virtvboxd', 'section': '8', 'install': conf.has('WITH_VBOX') = }, + { 'name': 'virtvzd', 'section': '8', 'install': conf.has('WITH_VZ') }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D +virtvzd +=3D=3D=3D=3D=3D=3D=3D + +----------------------------------- +libvirt Virtuozzo management daemon +----------------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtvzd`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 Virtuoz= zo +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 automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtvzd`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +When run as *root* +------------------ + +* ``@SYSCONFDIR@/libvirt/virtvzd.conf`` + +The default configuration file used by ``virtvzd``, unless overridden on t= he +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`` opti= on. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/virtvzd.conf`` + +The default configuration file used by ``virtvzd``, unless overridden on t= he +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 u= se +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, ``virtvzd`` will u= se +``$HOME/.cache`` + + +EXAMPLES +=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvvz.html `_ --=20 2.29.2 From nobody Sat May 11 23:49:56 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1609867632; cv=none; d=zohomail.com; s=zohoarc; b=G25Ihm5vvk5oeVD8gzJI/Pg5VUD2KHe/MHjUDe7g5L1L/kXo43kUVT5OfutIGlQKxIIhimPLSg0qrygCvrT07cyxKysIbLhwgh81eco4bdy4e+uMg5U3aJtVlSUfVeU+q2Yn2eMJ31mEx/y9FlPorK8KLaZcLv6RIpPcOJ/EiMs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1609867632; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=QY7D4W+OpjW03s/wI8zf1fta/OLP9xKya2fEcrL8kRU=; b=M6Lk/eDJd5tv5hhCJG6ksL2db8r+/LZC0I5TOshIoAIpHD6ktkrccrfzPR91/1o/FoxvKj1dLS5NAFdU2lLs1+gIrXKykzDhmQlQWLpQcQWIPoIBmN8iZ3KQ7P9nbXEtDgttHGEClMJ1jPLlNrsnJP7+K0MLql7fo5XJW5Dvbrs= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 1609867632728391.0166182378804; Tue, 5 Jan 2021 09:27:12 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-395-jXFQKsRqM5GQTlRzWs2b2Q-1; Tue, 05 Jan 2021 12:26:38 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 359461005D53; Tue, 5 Jan 2021 17:26:31 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id BDFDC60BE5; Tue, 5 Jan 2021 17:26:30 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 890021809CAF; Tue, 5 Jan 2021 17:26:30 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 105HQS1T032491 for ; Tue, 5 Jan 2021 12:26:28 -0500 Received: by smtp.corp.redhat.com (Postfix) id 5925A60C15; Tue, 5 Jan 2021 17:26:28 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-197.ams2.redhat.com [10.36.114.197]) by smtp.corp.redhat.com (Postfix) with ESMTP id AF65060BE5; Tue, 5 Jan 2021 17:26:27 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1609867631; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=QY7D4W+OpjW03s/wI8zf1fta/OLP9xKya2fEcrL8kRU=; b=XgcLDYNb/6KeUfCBFf0A+DDAtl5YQ87rGqWE7x19JyAwbzPJxb1EilNrrMK91F3hrfXx2S hsaNwM064/KXIjhF5daf4YoG10rePwQNH5LUUMldAy01bbuM5wAc/WvOAnCnzNLYz09H0S DYkSkuS2kNHXuJ1qscXvYvmhTY1PBLg= X-MC-Unique: jXFQKsRqM5GQTlRzWs2b2Q-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2 16/16] docs: add manpage for virtxend Date: Tue, 5 Jan 2021 17:25:54 +0000 Message-Id: <20210105172554.943968-17-berrange@redhat.com> In-Reply-To: <20210105172554.943968-1-berrange@redhat.com> References: <20210105172554.943968-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) This is an adaptation of the libvirtd manpage. Signed-off-by: Daniel P. Berrang=C3=A9 --- 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 d= river * `virtstoraged(8) `__ - libvirt storage pool managemen= t daemon * `virtvboxd(8) `__ - libvirt VirtualBox management daemon * `virtvzd(8) `__ - libvirt Virtuozzo management daemon +* `virtxend(8) `__ - libvirt Xen management daemon =20 Tools =3D=3D=3D=3D=3D 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 =3D [ { 'name': 'virtstoraged', 'section': '8', 'install': conf.has('WITH_STOR= AGE') }, { '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') }, ] =20 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 @@ +=3D=3D=3D=3D=3D=3D=3D=3D +virtxend +=3D=3D=3D=3D=3D=3D=3D=3D + +----------------------------- +libvirt Xen management daemon +----------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virtxend`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 vir= tual +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 automatical= ly +during startup. None the less it is recommended to avoid restarting with +running guests whenever practical. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D=3D=3D=3D + +``-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 cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` ``virtxend`` will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +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`` opti= on. + + +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 +=3D=3D=3D=3D=3D=3D=3D=3D + +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 +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), libvirtd(8), +`https://www.libvirt.org/daemons.html `_, +`https://www.libvirt.org/drvxen.html = `_ --=20 2.29.2