From 206fa68eec75138aa6903bae655a0acd94d2229f Mon Sep 17 00:00:00 2001 From: Jonathon Anderson Date: Fri, 21 Mar 2025 17:20:51 -0600 Subject: [PATCH] Various minor documentation updates - Document using mock to build RPMs - Clarify installing warewulf-dracut in the image - Fix vestigial references to v4.6.0rc2 - Closes: #1767 - Closes: #1769 Signed-off-by: Jonathon Anderson --- userdocs/overlays/overlays.rst | 5 +++++ userdocs/server/bootloaders.rst | 8 ++++---- userdocs/server/installation.rst | 28 ++++++++++++++++++++++------ 3 files changed, 31 insertions(+), 10 deletions(-) diff --git a/userdocs/overlays/overlays.rst b/userdocs/overlays/overlays.rst index eee44bbc..02adb76f 100644 --- a/userdocs/overlays/overlays.rst +++ b/userdocs/overlays/overlays.rst @@ -294,6 +294,11 @@ If a ``PasswordlessRoot`` tag is set to "true", the overlay will also insert a "passwordless" root entry. This can be particularly useful for accessing a cluster node when its network interface is not properly configured. +.. warning:: + + ``PasswordlessRoot`` is not recommended for production; it should only be + used during debugging, when normal authentication is not functional. + ignition -------- diff --git a/userdocs/server/bootloaders.rst b/userdocs/server/bootloaders.rst index 9132e1ec..babd1934 100644 --- a/userdocs/server/bootloaders.rst +++ b/userdocs/server/bootloaders.rst @@ -334,13 +334,13 @@ Warewulf provides a dracut module to configure the dracut initramfs to load the image. This module is available in the ``warewulf-dracut`` subpackage, which must be installed in the image. -With the ``warewulf-dracut`` package installed, you can build an initramfs -inside the image. +With the ``warewulf-dracut`` package installed in the image, you can then build +an initramfs inside the image. .. code-block:: shell - dnf -y install warewulf-dracut - dracut --force --no-hostonly --add wwinit --regenerate-all + wwctl image exec rockylinux-9 --build=false -- /usr/bin/dnf -y install https://github.com/warewulf/warewulf/releases/download/v4.6.0/warewulf-dracut-4.6.0-1.el9.noarch.rpm + wwctl image exec rockylinux-9 -- /usr/bin/dracut --force --no-hostonly --add wwinit --regenerate-all .. note:: diff --git a/userdocs/server/installation.rst b/userdocs/server/installation.rst index 986ab145..6b10187e 100644 --- a/userdocs/server/installation.rst +++ b/userdocs/server/installation.rst @@ -18,14 +18,14 @@ Rocky Linux 9 .. code-block:: console - # dnf install https://github.com/warewulf/warewulf/releases/download/v4.6.0rc2/warewulf-4.6.0rc2-1.el9.x86_64.rpm + # dnf install https://github.com/warewulf/warewulf/releases/download/v4.6.0/warewulf-4.6.0-1.el9.x86_64.rpm openSuse Leap ------------- .. code-block:: console - # zypper install https://github.com/warewulf/warewulf/releases/download/v4.6.0rc2/warewulf-4.6.0rc2-1.suse.lp155.x86_64.rpm + # zypper install https://github.com/warewulf/warewulf/releases/download/v4.6.0/warewulf-4.6.0-1.suse.lp155.x86_64.rpm Container images ================ @@ -97,9 +97,9 @@ appropriate substitutions: .. code-block:: bash - curl -LO https://github.com/warewulf/warewulf/releases/download/v4.6.0rc2/warewulf-4.6.0rc2.tar.gz - tar -xf warewulf-4.6.0rc2.tar.gz - cd warewulf-4.6.0rc2 + curl -LO https://github.com/warewulf/warewulf/releases/download/v4.6.0/warewulf-4.6.0.tar.gz + tar -xf warewulf-4.6.0.tar.gz + cd warewulf-4.6.0 make all && sudo make install Git @@ -118,7 +118,7 @@ from the main site, the GitHub releases page, or from a Git tag. git clone https://github.com/warewulf/warewulf.git cd warewulf - git checkout main # or switch to a tag like 'v4.6.0rc2' + git checkout main # or switch to a tag like 'v4.6.0' make all && sudo make install Runtime Dependencies @@ -134,6 +134,22 @@ services. Generally these are provided by your distribution. If you are using an Enterprise Linux compatible distribution you can install them with ``dnf install dhcp-server tftp-server nfs-utils``. +Building RPM packages from source +================================= + +You can also build RPM packages from source. + +.. code-block:: bash + + dnf -y install epel-release + dnf -y install make mock + git clone git@github.com:warewulf/warewulf.git + ( + cd warewulf + make clean && make dist warewulf.spec && mock -r rocky+epel-9-$(arch) --rebuild --spec=warewulf.spec --sources=. + ) + dnf -y install /var/lib/mock/rocky+epel-9-$(arch)/result/warewulf-*.$(arch).rpm + Starting warewulfd ==================