Merge pull request #1041 from mslacken/DocDnsmasq

Document installation instructions for dnsmasq

CHANGELOG.md

@@ -153,6 +153,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated WW_INTERNAL to 45 for upcoming 4.5.x release
 - Added documentation about of how to configure warewulf with 
   multiple networks
+- Added installation instructions for using dnsmasq
 
 ## [4.4.0] 2023-01-18
 

userdocs/contents/dnsmasq.rst

@@ -5,13 +5,58 @@ Dnsmasq
 Usage
 =====
 
-As experimental feature its possible to use `dnsmasq` instead of the ISC `dhcpd` server in combination
-with a `tFTP` server. The `dnsmasq` service is then acting as `dhcp` and `tftp` server. In order to keep
-the file `/etc/dnsmasq.d/ww4-hosts.conf` is created and must be included in the main `dnsmasq.conf` via
-the `conf-dir=/etc/dnsmasq.d` option.
+As experimental feature its possible to use ``dnsmasq`` instead of the ISC ``dhcpd`` server in combination with a ``TFTP`` server.
+The ``dnsmasq`` service is then acting as ``dhcp`` and ``TFTP`` server.
+In order to keep the file ``/etc/dnsmasq.d/ww4-hosts.conf`` is created and must be included in the main ``dnsmasq.conf`` via the ``conf-dir=/etc/dnsmasq.d`` option.
 
-Addionally in the configuration file `warewulf.conf` in the sections `dhcp` and `tftp` the systemd name of
-dnsmasq must set for the option `systemd name`.
 
-After this configuration steps its recommended to rebuild the host overlay with `wwctl overlay build -H` and
-the the services should be configured with `wwctl configure -a`.
+Installation
+------------
+
+Before the installation, make sure that ``dhcpd`` and ``tftp`` are disabled.
+You can do that with the commands:
+
+.. code-block:: shell
+
+   systemctl disable dhcpd
+   systemctl stop dhcpd
+   systemctl disable tftp
+   systemctl stop tftp
+
+Now you can install ``dnsmasq``.
+
+.. code-block:: shell
+
+   zypper install dnsmasq
+
+After the installation you have to instruct ``warewulf`` to use ``dnsmasq`` as its ``dhcpd`` and ``tftp`` service.
+``dnsmasq`` has to be specified in the configuration file ``/etc/warewulf/warewulf.conf``.
+
+.. code-block:: shell
+
+   tftp:
+     systemd name: dnsmasq
+   dhcp:
+     systemd name: dnsmasq
+
+The configuration of ``dnsmasq`` doesn't need to be changed, as the default configuration includes all files with following pattern ``/etc/dnsmasq.d/*conf`` into its configuration.
+This configuration is created by the overlay template ``host:/etc/dnsmasq.d/ww4-hosts.conf.ww``.
+In order to build this template run
+
+.. code-block:: shell
+
+   wwctl overlay build -H
+
+After that the ``dnsmasq`` service has to be enabled.
+Either
+
+.. code-block:: shell
+
+   systemctl enable --now dnsmasq
+
+or by (re)configuring warewulf with
+
+.. code-block:: shell
+
+   wwctl configure dhcp
+   wwctl configure tftp