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

10
userdocs/server/bootloaders.rst
View File

@@ -32,7 +32,7 @@ the Warewulf configuration process to configure the ``ipxe`` service.
bios->iPXE [lhead=cluster0,label="iPXE.efi"];
kernel [shape=record label="{kernel|ramdisk (root fs)|wwinit overlay}|extracted from node image"];
kernel [shape=record label="{kernel|ramdisk (root fs)|wwinit overlay}|extracted from OS image"];
ipxe_cfg->kernel[ltail=cluster0,label="http"];
}
@@ -235,7 +235,7 @@ Warewulf as a technology preview.
grubcfg[shape=record label="{grub.cfg|static under TFTP root}"];
grub->grubcfg[label="TFTP"];
}
kernel [shape=record label="{kernel|ramdisk (root fs)|wwinit overlay}|extracted from node image"];
kernel [shape=record label="{kernel|ramdisk (root fs)|wwinit overlay}|extracted from OS image"];
grubcfg->kernel[ltail=cluster1,label="http"];
}
@@ -308,9 +308,9 @@ diagram is the following:
digraph G{
node [shape=box];
efi [shape=record label="{EFI|boots from URI defined in filename}"];
shim [shape=record label="{shim.efi|replaces shim.efi with grubx64.efi in URI|extracted from node image}"];
grub [shape=record label="{grub.efi|checks for grub.cfg|extracted from node image}"]
kernel [shape=record label="{kernel|ramdisk (root fs)|wwinit overlay}|extracted from node image"];
shim [shape=record label="{shim.efi|replaces shim.efi with grubx64.efi in URI|extracted from OS image}"];
grub [shape=record label="{grub.efi|checks for grub.cfg|extracted from OS image}"]
kernel [shape=record label="{kernel|ramdisk (root fs)|wwinit overlay}|extracted from OS image"];
efi->shim [label="http"];
shim->grub [label="http"];
grub->kernel [label="http"];

2
userdocs/server/routes.rst
View File

@@ -93,7 +93,7 @@ kernel is taken from the node's assigned image.
``/image/{wwid}``
-----------------
Serves the raw node image file for the node identified by ``{wwid}``.
Serves the raw OS image file for the node identified by ``{wwid}``.
**Query parameters:** ``assetkey``, ``uuid``, ``compress``

4
userdocs/server/security.rst
View File

@@ -11,7 +11,7 @@ Provisioning Security
Provisioning is, by default, a relatively "insecure" process: there is generally
nothing preventing a user on a cluster node from spoofing a provision request
and downloading the node image and overlays for inspection. If any of these
and downloading the OS image and overlays for inspection. If any of these
include secrets (e.g., private keys) they are at risk of exposure.
There are multiple ways to secure the Warewulf provisioning process:
@@ -50,7 +50,7 @@ SELinux
The Warewulf server can be run with SELinux enabled in "targeted" and
"enforcing" mode.
For more information about running SELinux-enabled cluster node images, see
For more information about running SELinux-enabled cluster OS images, see
:ref:`SELinux-Enabled Images <selinux_images>`.
firewalld