kelvin/warewulf
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Distinguish between OS images and overlay images in documentation

Browse Source 
Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
Jonathon Anderson
2026-03-18 08:10:49 -06:00
parent 1fd8b65ebf
commit 7909598a3d
20 changed files with 89 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
userdocs/troubleshooting/known-issues.rst
View File

@@ -63,7 +63,7 @@ v4.6.0. <https://github.com/warewulf/warewulf/issues/892>`_
Image Size Considerations
=========================
Node images can grow quickly as packages and other files are added to them. Even
OS images can grow quickly as packages and other files are added to them. Even
these larger images are often not an issue in modern environments; but some
architectural limits exist that can impede the use of images larger than a few
gigabytes. Workarounds exist for these issues in most circumstances:
@@ -94,7 +94,7 @@ gigabytes. Workarounds exist for these issues in most circumstances:
* Some BIOS / firmware retain a "memory hole" feature for legacy devices, e.g.,
reserving a 1MB block of memory at the 15MB-16MB address range. This feature
can interfere with booting stateless node images.
can interfere with booting stateless OS images.
If you are still getting "Not enough memory" or "No space left on device"
errors, try disabling any "memory hole" features or updating your system BIOS

12
userdocs/troubleshooting/troubleshooting.rst
View File

@@ -66,7 +66,7 @@ cluster node's MAC address in place of 00:00:00:00:00:00.)
- The ``kernel`` command fetches a kernel for later booting.
- The ``imgextract`` command fetches and decompresses the images that will make
up the booted node image. In a typical environment this is used to load a
up the booted OS image. In a typical environment this is used to load a
minimal "initial ramdisk" which, then, boots the rest of the system. Warewulf,
by default, loads the entire image as an initial ramdisk, and also loads the
system and runtime overlays at this time.
@@ -91,7 +91,7 @@ enabled. To do so, substitute the ``boot`` command above.
You may be more familiar with specifying ``init=`` on the kernel command
line. ``rdinit`` indicates "ramdisk init." Since Warewulf, by default, boots
the node image as an initial ramdisk, we must use ``rdinit=`` here.
the OS image as an initial ramdisk, we must use ``rdinit=`` here.
GRUB
====
@@ -149,7 +149,7 @@ enabled. To do so, substitute the ``linux`` command above.
You may be more familiar with specifying ``init=`` on the kernel command
line. ``rdinit`` indicates "ramdisk init." Since Warewulf, by default, boots
the node image as an initial ramdisk, we must use ``rdinit=`` here.
the OS image as an initial ramdisk, we must use ``rdinit=`` here.
Dracut
======
@@ -217,8 +217,8 @@ the new configuration.
.. note::
The node image itself must have Podman (or the desired container runtime)
installed. See :ref:`images` for guidance on customizing node images.
The OS image itself must have Podman (or the desired container runtime)
installed. See :ref:`images` for guidance on customizing OS images.
For information on tuning tmpfs memory usage and NUMA interleaving behavior,
see :ref:`tmpfs-and-numa` below.
@@ -231,7 +231,7 @@ tmpfs and NUMA
Warewulf can optionally mount the root filesystem as ``tmpfs`` instead of the
default ``initramfs``. Warewulf will add ``mpol=interleave`` to the mount point
which will distribute the memory across all NUMA nodes. This avoids the
hotspotting that occurs when the default initramfs stores large node images on a
hotspotting that occurs when the default initramfs stores large OS images on a
single NUMA node. To enable this, set the rootfs type to tmpfs:
.. code-block:: shell