Audit and correct documentation, cobra help text, and log messages for accuracy
Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
@@ -30,7 +30,7 @@ Server management
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
# Configure all external services (DHCP, TFTP, NFS, SSH, hosts)
|
||||
# Configure all external services (TLS, warewulfd, TFTP, DHCP, NFS, SSH, hosts)
|
||||
wwctl configure --all
|
||||
|
||||
# Configure individual services
|
||||
|
||||
@@ -5,8 +5,8 @@ SELinux-enabled Images
|
||||
======================
|
||||
|
||||
Warewulf supports booting SELinux-enabled images, though nodes using SELinux
|
||||
must be configured to use tmpfs for their image file system. ("ramfs," often
|
||||
used by default, does not support extended file attributes, which are required
|
||||
must be configured to use tmpfs for their image file system. (The default
|
||||
``initramfs`` root does not support extended file attributes, which are required
|
||||
for SELinux context labeling.)
|
||||
|
||||
.. code-block:: bash
|
||||
@@ -26,4 +26,4 @@ in the warewulf-node-images repository.
|
||||
.. _An example: https://github.com/warewulf/warewulf-node-images/tree/main/examples/rockylinux-9-selinux
|
||||
|
||||
SELinux requires extended attributes, which aren't supported on a default
|
||||
``initrootfs``. Nodes using SELinux should specify ``--root=tmpfs``.
|
||||
``initramfs`` root. Nodes using SELinux should specify ``--root=tmpfs``.
|
||||
@@ -113,7 +113,8 @@ To include an explicit comma in the value, enclose the value in inner-quotes.
|
||||
Un-setting Node Fields
|
||||
----------------------
|
||||
|
||||
To un-set a field value, set the value to ``UNDEF``.
|
||||
To un-set a field value, set the value to ``UNDEF`` or ``UNSET`` (both are
|
||||
accepted).
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
|
||||
@@ -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``.
|
||||
|
||||
|
||||
@@ -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
|
||||
===========
|
||||
|
||||
|
||||
Reference in New Issue
Block a user