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

Audit and correct documentation, cobra help text, and log messages for accuracy

Browse Source 
Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
Jonathon Anderson
2026-03-18 16:58:39 -06:00
parent 7d56252d65
commit 9e526c23fc
23 changed files with 50 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
userdocs/server/configuration.rst
View File

@@ -124,7 +124,7 @@ warewulf
applied to the Warewulf server during configuration. (The host overlay is used
to configure external services.)
* ``warewulf::grubboot``: Controls whether iPXE (default) or GRUB is used as the
* ``warewulf:grubboot``: Controls whether iPXE (default) or GRUB is used as the
network bootloader.
dhcp
@@ -270,10 +270,10 @@ to operate in the host environment prior to deployment.
* ``image mounts:dest``: The path in the image to use for the mount.
* ``image mounts::readonly``: Whether the mount should be read-only (``true``)
* ``image mounts:readonly``: Whether the mount should be read-only (``true``)
or allow writes into the server path (``false``).
* ``image mounts::copy``: When ``true``, copy files into the image rather than
* ``image mounts:copy``: When ``true``, copy files into the image rather than
mount. This is useful for initializing files with a starting value from the
Warewulf server that should then be maintained as part of the image.
@@ -299,7 +299,7 @@ Override paths to images, overlays, and other Warewulf components.
* ``paths:sysconfdir``: The parent directory for the ``warewulf`` configuration
directory, which stores ``warewulf.conf`` and ``nodes.conf``.
* ``paths::cachedir``: The parent directory for the ``warewulf`` cache of OCI
* ``paths:cachedir``: The parent directory for the ``warewulf`` cache of OCI
images during ``wwctl image import``. The cache is stored at
``$cachedir/warewulf`` and can be cleared with ``wwctl clean``.

11
userdocs/server/wwctl.rst
View File

@@ -8,10 +8,10 @@ functionality.
* ``configure``: configures the Warewulf server and its external services
* ``node``: manages nodes in the cluster
* ``profiles``: defines common sets of node configuration which can be applied
* ``profile``: defines common sets of node configuration which can be applied
to multiple nodes
* ``image``: configures (node) images
* ``overlays``: manages overlays
* ``overlay``: manages overlays
* ``clean``: removes the OCI image cache and leftover overlay images from
deleted nodes
@@ -49,16 +49,21 @@ through the following command :
================================================================================
n1 RUNTIME_OVERLAY __RUNTIME__.img.gz 16
For each node, there are 4 different stages:
For each node, there are 7 different stages:
* **EFI**
* **IPXE**
* **KERNEL**
* **IMAGE**
* **INITRAMFS**
* **SYSTEM_OVERLAY**
* **RUNTIME_OVERLAY**
You can use the ``wwctl node status`` to check communication between the
Warewulf server (``warewulfd``) and the Warewulf client (``wwclient``).
.. note:: A provisioning workflow might not use every stage.
Maintenance
===========