Update customizations.services documentation

Make it clear that the services are added to services already listed in
the image templates, and that you can specify any systemd unit filename.

Older releases are more restrictive, and this documentation will need to
be updated when these changes are backported.

(cherry picked from commit 4f701e7e92)

Related: rhbz#1709595
This commit is contained in:
Brian C. Lane 2019-04-17 09:38:59 -07:00
parent cdf0cbbc5e
commit e9231ae65e
1 changed files with 8 additions and 13 deletions

View File

@ -301,25 +301,20 @@ This cannot be overridden by the blueprint.
[customizations.services] [customizations.services]
************************* *************************
This section can be used to control which services are enabled at boot time. Some image types This section can be used to control which services are enabled at boot time.
already have services enabled or disabled in order for the image to work correctly, and cannot Some image types already have services enabled or disabled in order for the
be overridden. eg. ``ami`` requires ``sshd``, ``chronyd``, and ``cloud-init``. Without them the image will image to work correctly, and cannot be overridden. eg. ``ami`` requires
not boot. ``sshd``, ``chronyd``, and ``cloud-init``. Without them the image will not
boot. Blueprint services are added to, not replacing, the list already in the
templates, if any.
The service names are systemd service units. On RHEL7 only ``.service`` units can be The service names are systemd service units. You may specify any systemd unit
enabled or disabled. Other releases may specify any systemd unit file, eg. ``cockpit.socket`` file accepted by ``systemctl enable`` eg. ``cockpit.socket``::
[customizations.services] [customizations.services]
enabled = ["sshd", "cockpit.socket", "httpd"] enabled = ["sshd", "cockpit.socket", "httpd"]
disabled = ["postfix", "telnetd"] disabled = ["postfix", "telnetd"]
.. warning::
The service must be installed, otherwise systemd will fail when trying to enable or disable
the nonexistant service.
TODO -- Confirm this is still true and if not, on which releases
[[repos.git]] [[repos.git]]
~~~~~~~~~~~~~ ~~~~~~~~~~~~~