From f65607190e4efe1b4ea99ebfa11f6eb41bf7a839 Mon Sep 17 00:00:00 2001 From: Christian Goll Date: Thu, 21 Nov 2024 15:03:29 +0100 Subject: [PATCH] added documentation for site overlays Signed-off-by: Christian Goll --- CHANGELOG.md | 1 + userdocs/contents/overlays.rst | 12 +++++++++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c2d716da..41975327 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -81,6 +81,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). - Provide detected kernel version to overlay templates. #1556 - Bump github.com/containers/storage from 1.53.0 to 1.55.2 #1316, #892 - Process nodes.conf path dynamically from config. #1595, #1596, #1569 +- Split overlays into distribution and site overlays. #831 ### Removed diff --git a/userdocs/contents/overlays.rst b/userdocs/contents/overlays.rst index 7519c826..d4be9d1d 100644 --- a/userdocs/contents/overlays.rst +++ b/userdocs/contents/overlays.rst @@ -25,11 +25,17 @@ overlay in two different ways: The default profile has both a **wwinit** and a **runtime** overlay configured. +Warewulf distinguishes between **distribution** shipped with warewulf +and **site** overlays which are created by the end user. A **site** takes +always precedence over a **distribution** overlay with the sane name. +Any modification of a **distribution** overlay with ``wwctl`` will create +a **site** overlay with the same name. +The **site** overlays are place normally under ``/etc/warewulf/overlays``. Overlays are compiled for each compute node individually. -Provided overlays -================= +Provided distribution overlays +============================== These overlays are provided as part of Warewulf. @@ -222,7 +228,7 @@ via the ``-o`` flag. On clusters with large numbers of nodes a significant speedup can be achieved by building overlays in parallel. Adding parallel overlay building to `wwctl` is planned, see issue `#1087 `_. -Until parallel overlay building is implemented, builds can be easily done in +Until parallel overlay building is implemented, builds can be easily done in parallel with Gnu `parallel` or `xargs`, for example: .. code-block:: console