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

Fix syntax errors in userdocs/

Browse Source 
Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
Jonathon Anderson
2026-03-11 23:03:45 -06:00
parent 73a71abfe2
commit cd60acf271
13 changed files with 27 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
userdocs/server/bootloaders.rst
View File

@@ -245,7 +245,7 @@ advantage that secure boot can be used. That means that only the signed kernel
of a distribution can be booted. This can be a huge security benefit for some
scenarios.
In order to enable the grub boot method it has to be enabled in `warewulf.conf`.
In order to enable the grub boot method it has to be enabled in ``warewulf.conf``.
.. code-block:: yaml
@@ -276,14 +276,14 @@ Secure boot
If secure boot is enabled at every step a signature is checked and the boot
process fails if this check fails. The shim typically only includes the key for
a single operating system, which means that each distribution needs separate
`shim` and `grub` executables. Warewulf extracts these binaries from the images.
``shim`` and ``grub`` executables. Warewulf extracts these binaries from the images.
If the node is unknown to Warewulf or can't be identified during the TFTP boot
phase, the shim/grub binaries of the host in which Warewulf is running are used.
Install shim and efi
--------------------
`shim.efi` and `grub.efi` must be installed in the image for it to be
``shim.efi`` and ``grub.efi`` must be installed in the image for it to be
booted by GRUB.
.. code-block:: console
@@ -316,7 +316,7 @@ diagram is the following:
grub->kernel [label="http"];
}
Warewulf delivers the initial `shim.efi` and `grub.efi` via http as taken
Warewulf delivers the initial ``shim.efi`` and ``grub.efi`` via http as taken
directly from the node's assigned image.
.. _booting with dracut:
@@ -394,5 +394,5 @@ during boot.
The wwinit module provisions to tmpfs. By default, tmpfs is permitted to use up
to 50% of physical memory. This size limit may be adjusted using the kernel
argument `wwinit.tmpfs.size`. (This parameter is passed to the `size` option
argument ``wwinit.tmpfs.size``. (This parameter is passed to the ``size`` option
during tmpfs mount. See ``tmpfs(5)`` for more details.)

2
userdocs/server/configuration.rst
View File

@@ -109,7 +109,7 @@ warewulf
can be specified at ``wwclient:port``.)
Changing this option requires rebuilding node overlays and rebooting compute
nodes to configure them to use a privileged port for `wwclient`.
nodes to configure them to use a privileged port for ``wwclient``.
* ``warewulf:update interval``: This defines the frequency (in seconds) with
which the Warewulf client on the compute node fetches overlay updates.

2
userdocs/server/security.rst
View File

@@ -36,7 +36,7 @@ There are multiple ways to secure the Warewulf provisioning process:
privileged (< 1024) TCP port. This prevents unprivileged cluster users from
being able to retrieve the runtime overlay.
* When the nodes are booted via `shim` and `grub` Secure Boot can be enabled.
* When the nodes are booted via ``shim`` and ``grub`` Secure Boot can be enabled.
This means that the nodes only boot the kernel which is provided by the
distributor and also custom complied modules can't be loaded.