diff --git a/docs/v4.5.x/.buildinfo b/docs/v4.5.x/.buildinfo index c16ad897..73c1620d 100644 --- a/docs/v4.5.x/.buildinfo +++ b/docs/v4.5.x/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 46a82930aa27e8dc7a2c4bccf6897d7f +config: e0466d9775a7e5b2280ab7869634cd4c tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/v4.5.x/_sources/contents/boot-management.rst.txt b/docs/v4.5.x/_sources/contents/boot-management.rst.txt index 586a98f6..4ab8cbfd 100644 --- a/docs/v4.5.x/_sources/contents/boot-management.rst.txt +++ b/docs/v4.5.x/_sources/contents/boot-management.rst.txt @@ -32,81 +32,6 @@ Booting with iPXE ipxe_cfg->kernel[ltail=cluster0,label="http"]; } -Booting with dracut -------------------- - -Some systems, typically due to limitations in their BIOS or EFI -firmware, are unable to load container image of a certain size -directly with a traditional bootloader, either iPXE or GRUB. As a -workaround for such systems, Warewulf can be configured to load a -dracut initramfs from the container and to use that initramfs to load -the full container image. - -Warewulf provides a dracut module to configure the dracut initramfs to -load the container image. This module is available in the -``warewulf-dracut`` subpackage, which must be installed in the -container image. - -With the ``warewulf-dracut`` package installed, you can build an -initramfs inside the container. - -.. code-block:: shell - - dnf -y install warewulf-dracut - dracut --force --no-hostonly --add wwinit --kver $(ls /lib/modules | head -n1) - -Set the node's iPXE template to ``dracut`` to direct iPXE to fetch the -node's initramfs image and boot with dracut semantics, rather than -booting the node image directly. - -.. note:: - - Warewulf iPXE templates are located at ``/etc/warewulf/ipxe/`` when - Warewulf is installed via official packages. You can learn more - about how dracut booting works by inspecting its iPXE template at - ``/etc/warewulf/ipxe/dracut.ipxe``. - -.. code-block:: shell - - wwctl node set wwnode1 --ipxe dracut - -.. note:: - - The iPXE template may be set at the node or profile level. - -Alternatively, to direct GRUB to fetch the node's initramfs image and boot with -dracut semantics, set a ``GrubMenuEntry`` tag for the node. - -.. note:: - - Warewulf configures GRUB with a template located at - ``/etc/warewulf/grub/grub.cfg.ww``. Inspect the template to learn more about - the dracut booting process. - -.. code-block:: shell - - wwctl node set wwnode1 --tagadd GrubMenuEntry=dracut - -.. note:: - - The ``GrubMenuEntry`` variable may be set at the node or profile level. - -During boot, ``warewulfd`` will detect and dynamically serve an -initramfs from a node's container image in much the same way that it -can serve a kernel from a container image. This image is loaded by -iPXE (or GRUB) which directs dracut to fetch the node's container image -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 adjustd -using the kernel argument `wwinit.tmpfs.size`. (This parameter is -passed to the `size` option during tmpfs mount. See ``tmpfs(5)`` for -more details.) - -.. warning:: - - Kernel overrides are not currently fully supported during dracut initramfs boot. - Booting with GRUB ================= @@ -214,3 +139,79 @@ is the following: Warewulf delivers the initial `shim.efi` and `grub.efi` via http as taken directly from the node's assigned container. + +Booting with dracut +=================== + +Some systems, typically due to limitations in their BIOS or EFI +firmware, are unable to load container image of a certain size +directly with a traditional bootloader, either iPXE or GRUB. As a +workaround for such systems, Warewulf can be configured to load a +dracut initramfs from the container and to use that initramfs to load +the full container image. + +Warewulf provides a dracut module to configure the dracut initramfs to +load the container image. This module is available in the +``warewulf-dracut`` subpackage, which must be installed in the +container image. + +With the ``warewulf-dracut`` package installed, you can build an +initramfs inside the container. + +.. code-block:: shell + + dnf -y install warewulf-dracut + dracut --force --no-hostonly --add wwinit --kver $(ls /lib/modules | head -n1) + +Set the node's iPXE template to ``dracut`` to direct iPXE to fetch the +node's initramfs image and boot with dracut semantics, rather than +booting the node image directly. + +.. note:: + + Warewulf iPXE templates are located at ``/etc/warewulf/ipxe/`` when + Warewulf is installed via official packages. You can learn more + about how dracut booting works by inspecting its iPXE template at + ``/etc/warewulf/ipxe/dracut.ipxe``. + +.. code-block:: shell + + wwctl node set wwnode1 --ipxe dracut + +.. note:: + + The iPXE template may be set at the node or profile level. + +Alternatively, to direct GRUB to fetch the node's initramfs image and boot with +dracut semantics, set a ``GrubMenuEntry`` tag for the node. + +.. note:: + + Warewulf configures GRUB with a template located at + ``/etc/warewulf/grub/grub.cfg.ww``. Inspect the template to learn more about + the dracut booting process. + +.. code-block:: shell + + wwctl node set wwnode1 --tagadd GrubMenuEntry=dracut + +.. note:: + + The ``GrubMenuEntry`` variable may be set at the node or profile level. + +During boot, ``warewulfd`` will detect and dynamically serve an +initramfs from a node's container image in much the same way that it +can serve a kernel from a container image. This image is loaded by +iPXE (or GRUB) which directs dracut to fetch the node's container image +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 adjustd +using the kernel argument `wwinit.tmpfs.size`. (This parameter is +passed to the `size` option during tmpfs mount. See ``tmpfs(5)`` for +more details.) + +.. warning:: + + Kernel overrides are not currently fully supported during dracut initramfs boot. + diff --git a/docs/v4.5.x/_static/searchtools.js b/docs/v4.5.x/_static/searchtools.js index 92da3f8b..b08d58c9 100644 --- a/docs/v4.5.x/_static/searchtools.js +++ b/docs/v4.5.x/_static/searchtools.js @@ -178,7 +178,7 @@ const Search = { htmlToText: (htmlString, anchor) => { const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - for (const removalQuery of [".headerlinks", "script", "style"]) { + for (const removalQuery of [".headerlink", "script", "style"]) { htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); } if (anchor) { @@ -328,13 +328,14 @@ const Search = { for (const [title, foundTitles] of Object.entries(allTitles)) { if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { for (const [file, id] of foundTitles) { - let score = Math.round(100 * queryLower.length / title.length) + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles normalResults.push([ docNames[file], titles[file] !== title ? `${titles[file]} > ${title}` : title, id !== null ? "#" + id : "", null, - score, + score + boost, filenames[file], ]); } diff --git a/docs/v4.5.x/contents/boot-management.html b/docs/v4.5.x/contents/boot-management.html index 2177f567..3b844943 100644 --- a/docs/v4.5.x/contents/boot-management.html +++ b/docs/v4.5.x/contents/boot-management.html @@ -60,16 +60,14 @@
  • Container Management
  • Kernel Management
  • Boot Management
  • Node Configuration
    • @@ -149,71 +147,6 @@

    Booting with iPXE -
    -

    Booting with dracut

    -

    Some systems, typically due to limitations in their BIOS or EFI -firmware, are unable to load container image of a certain size -directly with a traditional bootloader, either iPXE or GRUB. As a -workaround for such systems, Warewulf can be configured to load a -dracut initramfs from the container and to use that initramfs to load -the full container image.

    -

    Warewulf provides a dracut module to configure the dracut initramfs to -load the container image. This module is available in the -warewulf-dracut subpackage, which must be installed in the -container image.

    -

    With the warewulf-dracut package installed, you can build an -initramfs inside the container.

    -
    dnf -y install warewulf-dracut
-dracut --force --no-hostonly --add wwinit --kver $(ls /lib/modules | head -n1)
-
    -
    -

    Set the node’s iPXE template to dracut to direct iPXE to fetch the -node’s initramfs image and boot with dracut semantics, rather than -booting the node image directly.

    -
    -

    Note

    -

    Warewulf iPXE templates are located at /etc/warewulf/ipxe/ when -Warewulf is installed via official packages. You can learn more -about how dracut booting works by inspecting its iPXE template at -/etc/warewulf/ipxe/dracut.ipxe.

    -
    -
    wwctl node set wwnode1 --ipxe dracut
-
    -
    -
    -

    Note

    -

    The iPXE template may be set at the node or profile level.

    -
    -

    Alternatively, to direct GRUB to fetch the node’s initramfs image and boot with -dracut semantics, set a GrubMenuEntry tag for the node.

    -
    -

    Note

    -

    Warewulf configures GRUB with a template located at -/etc/warewulf/grub/grub.cfg.ww. Inspect the template to learn more about -the dracut booting process.

    -
    -
    wwctl node set wwnode1 --tagadd GrubMenuEntry=dracut
-
    -
    -
    -

    Note

    -

    The GrubMenuEntry variable may be set at the node or profile level.

    -
    -

    During boot, warewulfd will detect and dynamically serve an -initramfs from a node’s container image in much the same way that it -can serve a kernel from a container image. This image is loaded by -iPXE (or GRUB) which directs dracut to fetch the node’s container image -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 adjustd -using the kernel argument wwinit.tmpfs.size. (This parameter is -passed to the size option during tmpfs mount. See tmpfs(5) for -more details.)

    -
    -

    Warning

    -

    Kernel overrides are not currently fully supported during dracut initramfs boot.

    -
    -

    Booting with GRUB

    @@ -302,6 +235,71 @@

    http boot +

    Booting with dracut

    +

    Some systems, typically due to limitations in their BIOS or EFI +firmware, are unable to load container image of a certain size +directly with a traditional bootloader, either iPXE or GRUB. As a +workaround for such systems, Warewulf can be configured to load a +dracut initramfs from the container and to use that initramfs to load +the full container image.

    +

    Warewulf provides a dracut module to configure the dracut initramfs to +load the container image. This module is available in the +warewulf-dracut subpackage, which must be installed in the +container image.

    +

    With the warewulf-dracut package installed, you can build an +initramfs inside the container.

    +
    dnf -y install warewulf-dracut
+dracut --force --no-hostonly --add wwinit --kver $(ls /lib/modules | head -n1)
+
    +
    +

    Set the node’s iPXE template to dracut to direct iPXE to fetch the +node’s initramfs image and boot with dracut semantics, rather than +booting the node image directly.

    +
    +

    Note

    +

    Warewulf iPXE templates are located at /etc/warewulf/ipxe/ when +Warewulf is installed via official packages. You can learn more +about how dracut booting works by inspecting its iPXE template at +/etc/warewulf/ipxe/dracut.ipxe.

    +
    +
    wwctl node set wwnode1 --ipxe dracut
+
    +
    +
    +

    Note

    +

    The iPXE template may be set at the node or profile level.

    +
    +

    Alternatively, to direct GRUB to fetch the node’s initramfs image and boot with +dracut semantics, set a GrubMenuEntry tag for the node.

    +
    +

    Note

    +

    Warewulf configures GRUB with a template located at +/etc/warewulf/grub/grub.cfg.ww. Inspect the template to learn more about +the dracut booting process.

    +
    +
    wwctl node set wwnode1 --tagadd GrubMenuEntry=dracut
+
    +
    +
    +

    Note

    +

    The GrubMenuEntry variable may be set at the node or profile level.

    +
    +

    During boot, warewulfd will detect and dynamically serve an +initramfs from a node’s container image in much the same way that it +can serve a kernel from a container image. This image is loaded by +iPXE (or GRUB) which directs dracut to fetch the node’s container image +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 adjustd +using the kernel argument wwinit.tmpfs.size. (This parameter is +passed to the size option during tmpfs mount. See tmpfs(5) for +more details.)

    +
    +

    Warning

    +

    Kernel overrides are not currently fully supported during dracut initramfs boot.

    +
    +

    diff --git a/docs/v4.5.x/index.html b/docs/v4.5.x/index.html index f2b02c44..06f681f4 100644 --- a/docs/v4.5.x/index.html +++ b/docs/v4.5.x/index.html @@ -176,6 +176,7 @@

    User GuideBoot Management
  • Node Configuration