added documentation for site overlays

Signed-off-by: Christian Goll <cgoll@suse.com>
This commit is contained in:
Christian Goll
2024-11-21 15:03:29 +01:00
parent d5fc7e9320
commit f65607190e
2 changed files with 10 additions and 3 deletions

View File

@@ -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 - Provide detected kernel version to overlay templates. #1556
- Bump github.com/containers/storage from 1.53.0 to 1.55.2 #1316, #892 - 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 - Process nodes.conf path dynamically from config. #1595, #1596, #1569
- Split overlays into distribution and site overlays. #831
### Removed ### Removed

View File

@@ -25,11 +25,17 @@ overlay in two different ways:
The default profile has both a **wwinit** and a **runtime** overlay The default profile has both a **wwinit** and a **runtime** overlay
configured. 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. Overlays are compiled for each compute node individually.
Provided overlays Provided distribution overlays
================= ==============================
These overlays are provided as part of Warewulf. 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 On clusters with large numbers of nodes a significant speedup can be achieved
by building overlays in parallel. Adding parallel overlay building to `wwctl` by building overlays in parallel. Adding parallel overlay building to `wwctl`
is planned, see issue `#1087 <https://github.com/warewulf/warewulf/issues/1087>`_. is planned, see issue `#1087 <https://github.com/warewulf/warewulf/issues/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: parallel with Gnu `parallel` or `xargs`, for example:
.. code-block:: console .. code-block:: console