From 24ae9305ce39fe36af0d281461c99f1959bfa922 Mon Sep 17 00:00:00 2001 From: Jonathon Anderson Date: Sat, 16 Mar 2024 22:35:58 -0600 Subject: [PATCH 1/2] Document overriding paths in warewulf.conf - Close: #635 Signed-off-by: Jonathon Anderson --- CHANGELOG.md | 1 + userdocs/contents/configuration.rst | 25 ++++++++++++++++++++++++- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 257efc40..169de0a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Add multiple output formats (yaml & json) support. #447 - More aliases for many wwctl commands - Add support to render template using `host` or `$(uname -n)` as the value of `overlay show --render`. #623 +- Document warewulf.conf:paths. #635 ### Changed diff --git a/userdocs/contents/configuration.rst b/userdocs/contents/configuration.rst index 8b737be2..355bdea0 100644 --- a/userdocs/contents/configuration.rst +++ b/userdocs/contents/configuration.rst @@ -10,7 +10,7 @@ warewulf.conf ============= The Warewulf configuration exists as follows in the current version of -Warewulf (4.4.0): +Warewulf (4.5.0): .. code-block:: yaml @@ -118,6 +118,29 @@ explained as follows: during ``container exec`` or ``container shell``, typically to allow them to operate in the host environment prior to deployment. +Paths +----- + +*New in Warewulf v4.5.0* + +Default paths to containers, overlays, and other Warewulf components +may be overridden using ``warewulf.conf:paths``. + +.. code-block:: yaml + + paths: + bindir: /usr/bin + sysconfdir: /etc + localstatedir: /var/lib + ipxesource: /usr/share/ipxe + srvdir: /var/lib + firewallddir: /usr/lib/firewalld/services + systemddir: /usr/lib/systemd/system + wwoverlaydir: /var/lib/warewulf/overlays + wwchrootdir: /var/lib/warewulf/chroots + wwprovisiondir: /var/lib/warewulf/provision + wwclientdir: /warewulf + nodes.conf ========== From 328da6c7905ff1c339f823de292a1183417c759b Mon Sep 17 00:00:00 2001 From: Jonathon Anderson Date: Mon, 25 Mar 2024 15:18:38 -0600 Subject: [PATCH 2/2] Add detail about path configuration Also removed paths that don't actually affect Warewulf behavior. Signed-off-by: Jonathon Anderson --- userdocs/contents/configuration.rst | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/userdocs/contents/configuration.rst b/userdocs/contents/configuration.rst index 355bdea0..c6214b95 100644 --- a/userdocs/contents/configuration.rst +++ b/userdocs/contents/configuration.rst @@ -129,18 +129,28 @@ may be overridden using ``warewulf.conf:paths``. .. code-block:: yaml paths: - bindir: /usr/bin sysconfdir: /etc localstatedir: /var/lib ipxesource: /usr/share/ipxe - srvdir: /var/lib - firewallddir: /usr/lib/firewalld/services - systemddir: /usr/lib/systemd/system wwoverlaydir: /var/lib/warewulf/overlays wwchrootdir: /var/lib/warewulf/chroots wwprovisiondir: /var/lib/warewulf/provision wwclientdir: /warewulf +* ``sysconfdir``: The parent directory for the ``warewulf`` configuration directory, + which stores ``warewulf.conf`` and ``nodes.conf``. + +* ``ipxesource``: Where to get iPXE binaries. + These files are copied to ``warewulf.conf:tftp:tftproot`` by ``wwctl configure``. + +* ``wwoverlaydir``: The source for Warewulf overlays. + +* ``wwchrootdir``: The source for Warewulf containers. + +* ``wwprovisiondir``: Where to store built overlays, built containers, and imported kernels. + +* ``wwclientdir``: Where the Warewulf client looks for its configuration on a provisioned node. + nodes.conf ==========