From: Martin Kletzander Date: Tue, 18 Oct 2022 12:15:38 +0000 (+0200) Subject: docs: Do not support non-socket activated modular daemons with systemd X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=f53988d657c6aafd7aa4f2070df01c43f1a936ab;p=libvirt.git docs: Do not support non-socket activated modular daemons with systemd Due to the setup of the modular daemon service files the reverting to non-socket activated daemons could have never worked. The reason is that masking the socket files prevents starting the daemons since they require (as in Requires= rather than Wants= in the service file) the sockets. On top of that it creates issues with some libvirt-guests setups and needlessly increases our support matrix. Nothing prevents users to modify their setup in a way that will still work without socket activation, but supporting such setup only creates burden on our part. This technically reverts most of commit 59d30adacd1d except the change made to the libvirtd manpage since the monolithic daemon still supports traditional mode of starting even on systemd. Signed-off-by: Martin Kletzander --- diff --git a/docs/manpages/virtinterfaced.rst b/docs/manpages/virtinterfaced.rst index 5777dba638..17884ed701 100644 --- a/docs/manpages/virtinterfaced.rst +++ b/docs/manpages/virtinterfaced.rst @@ -39,26 +39,25 @@ during startup. None the less it is recommended to avoid restarting with running guests whenever practical. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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 +Socket activation mode +---------------------- + +On hosts with systemd it is started in socket activation mode and it will rely +on systemd to create and listen on the UNIX 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: -:: +Traditional service mode +------------------------ - $ systemctl mask virtinterfaced.socket virtinterfaced-ro.socket \ - virtinterfaced-admin.socket +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS diff --git a/docs/manpages/virtlxcd.rst b/docs/manpages/virtlxcd.rst index aebc8adb58..10e2c7035b 100644 --- a/docs/manpages/virtlxcd.rst +++ b/docs/manpages/virtlxcd.rst @@ -39,40 +39,25 @@ during startup. None the less it is recommended to avoid restarting with running guests whenever practical. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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: - -:: +Socket activation mode +---------------------- - $ systemctl mask virtlxcd.socket virtlxcd-ro.socket \ - virtlxcd-admin.socket +On hosts with systemd it is started in socket activation mode and 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. -If using libvirt-guests service then the ordering for that service needs to be -adapted so that it is ordered after the service unit instead of the socket unit. -Since dependencies and ordering cannot be changed with drop-in overrides, the -whole libvirt-guests unit file needs to be changed. In order to preserve such -change copy the installed ``/usr/lib/systemd/system/libvirt-guests.service`` to -``/etc/systemd/system/libvirt-guests.service`` and make the change there, -specifically make sure the ``After=`` ordering mentions ``virtlxcd.service`` and -not ``virtlxcd.socket``: -:: +Traditional service mode +------------------------ - [Unit] - After=virtlxcd.service +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS diff --git a/docs/manpages/virtnetworkd.rst b/docs/manpages/virtnetworkd.rst index 6d9c5e5fa3..4a7d99a9d3 100644 --- a/docs/manpages/virtnetworkd.rst +++ b/docs/manpages/virtnetworkd.rst @@ -39,26 +39,25 @@ during startup. None the less it is recommended to avoid restarting with running guests whenever practical. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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 +Socket activation mode +---------------------- + +On hosts with systemd it is started in socket activation mode and it will rely +on systemd to create and listen on the UNIX 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: -:: +Traditional service mode +------------------------ - $ systemctl mask virtnetworkd.socket virtnetworkd-ro.socket \ - virtnetworkd-admin.socket +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS diff --git a/docs/manpages/virtnodedevd.rst b/docs/manpages/virtnodedevd.rst index ef968e486e..8ee108c37e 100644 --- a/docs/manpages/virtnodedevd.rst +++ b/docs/manpages/virtnodedevd.rst @@ -38,26 +38,25 @@ during startup. None the less it is recommended to avoid restarting with running guests whenever practical. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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 +Socket activation mode +---------------------- + +On hosts with systemd it is started in socket activation mode and it will rely +on systemd to create and listen on the UNIX 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: -:: +Traditional service mode +------------------------ - $ systemctl mask virtnodedevd.socket virtnodedevd-ro.socket \ - virtnodedevd-admin.socket +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS diff --git a/docs/manpages/virtnwfilterd.rst b/docs/manpages/virtnwfilterd.rst index 4faa6b225d..60fdb30d5c 100644 --- a/docs/manpages/virtnwfilterd.rst +++ b/docs/manpages/virtnwfilterd.rst @@ -39,26 +39,25 @@ during startup. None the less it is recommended to avoid restarting with running guests whenever practical. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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 +Socket activation mode +---------------------- + +On hosts with systemd it is started in socket activation mode and it will rely +on systemd to create and listen on the UNIX 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: -:: +Traditional service mode +------------------------ - $ systemctl mask virtnwfilterd.socket virtnwfilterd-ro.socket \ - virtnwfilterd-admin.socket +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS diff --git a/docs/manpages/virtproxyd.rst b/docs/manpages/virtproxyd.rst index 0366935b9a..76156c9e02 100644 --- a/docs/manpages/virtproxyd.rst +++ b/docs/manpages/virtproxyd.rst @@ -48,20 +48,20 @@ and can be restarted at any time. Clients should expect to reconnect after the restart. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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 +Socket activation mode +---------------------- + +On hosts with systemd it is started in socket activation mode and it will rely +on systemd to create and listen on the UNIX, and optionally TCP/IP, sockets and +pass them as pre-opened file descriptors. In this mode most of the socket +related config options in ``/etc/libvirt/virtproxyd.conf`` will no longer have +any effect. To enable TCP or TLS sockets use either :: @@ -73,14 +73,13 @@ 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: -:: +Traditional service mode +------------------------ - $ systemctl mask virtproxyd.socket virtproxyd-ro.socket \ - virtproxyd-admin.socket virtproxyd-tls.socket virtproxyd-tcp.socket +On hosts without systemd, it will create and listen on UNIX sockets itself. +It will also listen on TCP/IP socket(s), according to the ``listen_tcp`` +and ``listen_tls`` options in ``/etc/libvirt/virtproxyd.conf`` OPTIONS diff --git a/docs/manpages/virtqemud.rst b/docs/manpages/virtqemud.rst index fa9a6ce375..15c5bc4ab5 100644 --- a/docs/manpages/virtqemud.rst +++ b/docs/manpages/virtqemud.rst @@ -39,40 +39,25 @@ during startup. None the less it is recommended to avoid restarting with running guests whenever practical. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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: - -:: +Socket activation mode +---------------------- - $ systemctl mask virtqemud.socket virtqemud-ro.socket \ - virtqemud-admin.socket +On hosts with systemd it is started in socket activation mode and 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. -If using libvirt-guests service then the ordering for that service needs to be -adapted so that it is ordered after the service unit instead of the socket unit. -Since dependencies and ordering cannot be changed with drop-in overrides, the -whole libvirt-guests unit file needs to be changed. In order to preserve such -change copy the installed ``/usr/lib/systemd/system/libvirt-guests.service`` to -``/etc/systemd/system/libvirt-guests.service`` and make the change there, -specifically make sure the ``After=`` ordering mentions ``virtqemud.service`` and -not ``virtqemud.socket``: -:: +Traditional service mode +------------------------ - [Unit] - After=virtqemud.service +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS diff --git a/docs/manpages/virtsecretd.rst b/docs/manpages/virtsecretd.rst index fffb3a24f6..87e1e5d5a1 100644 --- a/docs/manpages/virtsecretd.rst +++ b/docs/manpages/virtsecretd.rst @@ -38,26 +38,25 @@ during startup. None the less it is recommended to avoid restarting with running guests whenever practical. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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 +Socket activation mode +---------------------- + +On hosts with systemd it is started in socket activation mode and it will rely +on systemd to create and listen on the UNIX 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: -:: +Traditional service mode +------------------------ - $ systemctl mask virtsecretd.socket virtsecretd-ro.socket \ - virtsecretd-admin.socket +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS diff --git a/docs/manpages/virtstoraged.rst b/docs/manpages/virtstoraged.rst index 4ceae57e40..ab67a42b4a 100644 --- a/docs/manpages/virtstoraged.rst +++ b/docs/manpages/virtstoraged.rst @@ -39,26 +39,25 @@ during startup. None the less it is recommended to avoid restarting with running guests whenever practical. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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 +Socket activation mode +---------------------- + +On hosts with systemd it is started in socket activation mode and it will rely +on systemd to create and listen on the UNIX 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: -:: +Traditional service mode +------------------------ - $ systemctl mask virtstoraged.socket virtstoraged-ro.socket \ - virtstoraged-admin.socket +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS diff --git a/docs/manpages/virtvboxd.rst b/docs/manpages/virtvboxd.rst index f90de3451d..2fe8ae0009 100644 --- a/docs/manpages/virtvboxd.rst +++ b/docs/manpages/virtvboxd.rst @@ -37,40 +37,26 @@ Restarting ``virtvboxd`` does not interrupt running guests. Guests continue to operate and changes in their state will generally be picked up automatically during startup. -SYSTEM SOCKET ACTIVATION -======================== -The ``virtvboxd`` daemon is capable of starting in two modes. - -In the traditional mode, it will create and listen on UNIX sockets itself. +DAEMON STARTUP MODES +==================== -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. +The ``virtvboxd`` daemon is capable of starting in two modes. -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: -:: +Socket activation mode +---------------------- - $ systemctl mask virtvboxd.socket virtvboxd-ro.socket \ - virtvboxd-admin.socket +On hosts with systemd it is started in socket activation mode and 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. -If using libvirt-guests service then the ordering for that service needs to be -adapted so that it is ordered after the service unit instead of the socket unit. -Since dependencies and ordering cannot be changed with drop-in overrides, the -whole libvirt-guests unit file needs to be changed. In order to preserve such -change copy the installed ``/usr/lib/systemd/system/libvirt-guests.service`` to -``/etc/systemd/system/libvirt-guests.service`` and make the change there, -specifically make sure the ``After=`` ordering mentions ``virtvboxd.service`` and -not ``virtvboxd.socket``: -:: +Traditional service mode +------------------------ - [Unit] - After=virtvboxd.service +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS diff --git a/docs/manpages/virtvzd.rst b/docs/manpages/virtvzd.rst index 970719aac1..1837351aec 100644 --- a/docs/manpages/virtvzd.rst +++ b/docs/manpages/virtvzd.rst @@ -39,40 +39,25 @@ during startup. None the less it is recommended to avoid restarting with running guests whenever practical. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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: - -:: +Socket activation mode +---------------------- - $ systemctl mask virtvzd.socket virtvzd-ro.socket \ - virtvzd-admin.socket +On hosts with systemd it is started in socket activation mode and 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. -If using libvirt-guests service then the ordering for that service needs to be -adapted so that it is ordered after the service unit instead of the socket unit. -Since dependencies and ordering cannot be changed with drop-in overrides, the -whole libvirt-guests unit file needs to be changed. In order to preserve such -change copy the installed ``/usr/lib/systemd/system/libvirt-guests.service`` to -``/etc/systemd/system/libvirt-guests.service`` and make the change there, -specifically make sure the ``After=`` ordering mentions ``virtvzd.service`` and -not ``virtvzd.socket``: -:: +Traditional service mode +------------------------ - [Unit] - After=virtvzd.service +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS diff --git a/docs/manpages/virtxend.rst b/docs/manpages/virtxend.rst index cf7685ecc0..e3ced780aa 100644 --- a/docs/manpages/virtxend.rst +++ b/docs/manpages/virtxend.rst @@ -39,40 +39,25 @@ during startup. None the less it is recommended to avoid restarting with running guests whenever practical. -SYSTEM SOCKET ACTIVATION -======================== +DAEMON STARTUP MODES +==================== 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: - -:: +Socket activation mode +---------------------- - $ systemctl mask virtxend.socket virtxend-ro.socket \ - virtxend-admin.socket +On hosts with systemd it is started in socket activation mode and 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. -If using libvirt-guests service then the ordering for that service needs to be -adapted so that it is ordered after the service unit instead of the socket unit. -Since dependencies and ordering cannot be changed with drop-in overrides, the -whole libvirt-guests unit file needs to be changed. In order to preserve such -change copy the installed ``/usr/lib/systemd/system/libvirt-guests.service`` to -``/etc/systemd/system/libvirt-guests.service`` and make the change there, -specifically make sure the ``After=`` ordering mentions ``virtxend.service`` and -not ``virtxend.socket``: -:: +Traditional service mode +------------------------ - [Unit] - After=virtxend.service +On hosts without systemd, it will create and listen on UNIX sockets itself. OPTIONS