From nobody Sat Feb 7 08:28:26 2026 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=1605632540; cv=none; d=zohomail.com; s=zohoarc; b=W5NJo3DhUKYdOwlw9aVR5LARuCHjY40pQqo9ysXNirt4Wv0JEaQxpfBHOOQfD9DlU27Ly4z0B5SQOTto4xbVN9yuURSgSkLjNfD/R/M1WGzox7SNI73k8ChzawBQ0hemqVsN1Xl451C9uKN0mN1IoNq4IeaZuLPD1tPtwOzWGvc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1605632540; 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=HKcHnM4eUzCPW2wPIU2NJINem1SkkBnW7NUDY+2dZbc=; b=aTkuUtzXLLBw9XpyCeL0KAk0QNE5nr0H+eJpUH/rf3Fk3K5lYKOZELM2Vrzzxzpsx3QALEmC7ywmgC/kMwqdS2jj0PSFn4/SHsM1RXiivmAAyeMg2AHew0JlkwhctfRW/b+cXNxJk+ZS58qU5ortmIV9wknOEHnAxJoCvdom7NI= 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 1605632540013878.7077219826481; Tue, 17 Nov 2020 09:02:20 -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-156-B6kns3kPPhGrjoCpy6SwCQ-1; Tue, 17 Nov 2020 12:02:14 -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 111EB11BD34E; Tue, 17 Nov 2020 17:02:07 +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 E03481759F; Tue, 17 Nov 2020 17:02:06 +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 A6B0D181A271; Tue, 17 Nov 2020 17:02:06 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 0AHGAd6x027994 for ; Tue, 17 Nov 2020 11:10:39 -0500 Received: by smtp.corp.redhat.com (Postfix) id 5C7655B4A2; Tue, 17 Nov 2020 16:10:39 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-115-10.ams2.redhat.com [10.36.115.10]) by smtp.corp.redhat.com (Postfix) with ESMTP id 85D3D5B4BC; Tue, 17 Nov 2020 16:10:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1605632538; 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=HKcHnM4eUzCPW2wPIU2NJINem1SkkBnW7NUDY+2dZbc=; b=PL5J8OHwmFtS/TL5g/SEelBVEgVAAECKx0CMcx9nm9anOOUMIMZM8MaBfSMkpVPk48JncY tMpcVVRZRbey5tSeNdADURlFYCG/1DBbtVCMkGUIMIPakuQr5ktmNeItmuCNO0LC9oAD5y AtUI2CPTm7xMi12oMa1N0S88rY4Nu7M= X-MC-Unique: B6kns3kPPhGrjoCpy6SwCQ-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH 05/16] docs: add manpage for virtbhyved Date: Tue, 17 Nov 2020 16:10:16 +0000 Message-Id: <20201117161027.210543-6-berrange@redhat.com> In-Reply-To: <20201117161027.210543-1-berrange@redhat.com> References: <20201117161027.210543-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 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 | 7 ++ docs/manpages/meson.build | 1 + docs/manpages/virtbhyved.rst | 215 +++++++++++++++++++++++++++++++++++ 3 files changed, 223 insertions(+) create mode 100644 docs/manpages/virtbhyved.rst diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 6a2a1e065d..da835d62ec 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -12,6 +12,13 @@ These daemons provide functionality across multiple 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..4d1d36b161 --- /dev/null +++ b/docs/manpages/virtbhyved.rst @@ -0,0 +1,215 @@ +=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. + + +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 ``virtbhyved`` daemon is capable of starting in two modes. + +In the traditional mode, it will create and listen on UNIX sockets itself. + +In socket activation mode, it will rely on systemd to create and listen +on the UNIX sockets and pass them as pre-opened file descriptors. In this +mode most of the socket related config options in +``/etc/libvirt/virtbhyved.conf`` will no longer have any effect. + +Socket activation mode is generally the default when running on a host +OS that uses systemd. To revert to the traditional mode, all the socket +unit files must be masked: + +:: + + $ systemctl mask virtbhyved.socket virtbhyved-ro.socket \ + virtbhyved-admin.socket + + +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.28.0