Skip to content

Commit d19b05b

Browse files
committed
Update main docs
1 parent d1f6dfb commit d19b05b

File tree

107 files changed

+478
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+478
-5
lines changed

static/docs/main/_sources/reference/wwctl_configure.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,5 @@ SEE ALSO
4242
* :ref:`wwctl configure nfs <wwctl_configure_nfs>` - Manage and initialize NFS
4343
* :ref:`wwctl configure ssh <wwctl_configure_ssh>` - Manage and initialize SSH
4444
* :ref:`wwctl configure tftp <wwctl_configure_tftp>` - Manage and initialize TFTP
45+
* :ref:`wwctl configure warewulfd <wwctl_configure_warewulfd>` - Enable and start warewulfd
4546

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.. _wwctl_configure_warewulfd:
2+
3+
wwctl configure warewulfd
4+
-------------------------
5+
6+
Enable and start warewulfd
7+
8+
Synopsis
9+
~~~~~~~~
10+
11+
12+
Enable and starts the warewulfd service.
13+
14+
::
15+
16+
wwctl configure warewulfd [OPTIONS]
17+
18+
Options
19+
~~~~~~~
20+
21+
::
22+
23+
-h, --help help for warewulfd
24+
25+
Options inherited from parent commands
26+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27+
28+
::
29+
30+
-d, --debug Run with debugging messages enabled.
31+
-v, --verbose Run with increased verbosity.
32+
--warewulfconf string Set the warewulf configuration file
33+
34+
SEE ALSO
35+
~~~~~~~~
36+
37+
* :ref:`wwctl configure <wwctl_configure>` - Manage system services
38+

static/docs/main/_sources/troubleshooting/troubleshooting.rst.txt

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,3 +201,35 @@ Running Containers on Cluster Nodes
201201
Some container runtimes, notably Podman, require file system features that are
202202
not available in ``initrootfs``. Cluster nodes using Podman (and some other
203203
container runtimes) should be configured with ``--root=tmpfs``.
204+
205+
tmpfs and NUMA
206+
==============
207+
208+
Warewulf can optionally mount the root filesystem as ``tmpfs`` instead of the
209+
default ``initramfs``. Warewulf will add ``mpol=interleave`` to the mount point
210+
which will distribute the memory across all NUMA nodes. This avoids the
211+
hotspotting that occurs when the default initramfs stores large node images on a
212+
single NUMA node. To enable this, set the rootfs type to tmpfs:
213+
214+
.. code-block:: shell
215+
216+
wwctl profile set default --root=tmpfs
217+
218+
You may also adjust the tmpfs size via the ``wwinit.tmpfs.size`` kernel
219+
argument:
220+
221+
.. code-block:: shell
222+
223+
# Set tmpfs to use maximum 1GB
224+
wwctl profile set default --kernelargs="wwinit.tmpfs.size=1G"
225+
# You can also use a percentage of physical RAM
226+
wwctl profile set default --kernelargs="wwinit.tmpfs.size=25%"
227+
228+
By default this is set to 50% of physical RAM. Note that tmpfs is required for
229+
SELinux overlays since initramfs cannot preserve SELinux contexts.
230+
231+
.. note::
232+
233+
On some systems, it may also be necessary to include the ``noefi`` kernel
234+
argument. This works around specific EFI firmware bugs that can prevent
235+
proper memory release during the transition from ``initramfs`` to ``tmpfs``.

static/docs/main/contributing/contributing.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@
117117
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_nfs.html">wwctl configure nfs</a></li>
118118
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_ssh.html">wwctl configure ssh</a></li>
119119
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_tftp.html">wwctl configure tftp</a></li>
120+
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_warewulfd.html">wwctl configure warewulfd</a></li>
120121
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image.html">wwctl image</a></li>
121122
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_build.html">wwctl image build</a></li>
122123
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_copy.html">wwctl image copy</a></li>

static/docs/main/contributing/debugging.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@
112112
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_nfs.html">wwctl configure nfs</a></li>
113113
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_ssh.html">wwctl configure ssh</a></li>
114114
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_tftp.html">wwctl configure tftp</a></li>
115+
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_warewulfd.html">wwctl configure warewulfd</a></li>
115116
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image.html">wwctl image</a></li>
116117
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_build.html">wwctl image build</a></li>
117118
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_copy.html">wwctl image copy</a></li>

static/docs/main/contributing/development-environment.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@
113113
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_nfs.html">wwctl configure nfs</a></li>
114114
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_ssh.html">wwctl configure ssh</a></li>
115115
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_tftp.html">wwctl configure tftp</a></li>
116+
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_warewulfd.html">wwctl configure warewulfd</a></li>
116117
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image.html">wwctl image</a></li>
117118
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_build.html">wwctl image build</a></li>
118119
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_copy.html">wwctl image copy</a></li>

static/docs/main/contributing/documentation.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@
108108
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_nfs.html">wwctl configure nfs</a></li>
109109
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_ssh.html">wwctl configure ssh</a></li>
110110
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_tftp.html">wwctl configure tftp</a></li>
111+
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_warewulfd.html">wwctl configure warewulfd</a></li>
111112
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image.html">wwctl image</a></li>
112113
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_build.html">wwctl image build</a></li>
113114
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_copy.html">wwctl image copy</a></li>

static/docs/main/genindex.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@
105105
<li class="toctree-l1"><a class="reference internal" href="reference/wwctl_configure_nfs.html">wwctl configure nfs</a></li>
106106
<li class="toctree-l1"><a class="reference internal" href="reference/wwctl_configure_ssh.html">wwctl configure ssh</a></li>
107107
<li class="toctree-l1"><a class="reference internal" href="reference/wwctl_configure_tftp.html">wwctl configure tftp</a></li>
108+
<li class="toctree-l1"><a class="reference internal" href="reference/wwctl_configure_warewulfd.html">wwctl configure warewulfd</a></li>
108109
<li class="toctree-l1"><a class="reference internal" href="reference/wwctl_image.html">wwctl image</a></li>
109110
<li class="toctree-l1"><a class="reference internal" href="reference/wwctl_image_build.html">wwctl image build</a></li>
110111
<li class="toctree-l1"><a class="reference internal" href="reference/wwctl_image_copy.html">wwctl image copy</a></li>

static/docs/main/getting-started/debian-quickstart.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@
119119
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_nfs.html">wwctl configure nfs</a></li>
120120
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_ssh.html">wwctl configure ssh</a></li>
121121
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_tftp.html">wwctl configure tftp</a></li>
122+
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_warewulfd.html">wwctl configure warewulfd</a></li>
122123
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image.html">wwctl image</a></li>
123124
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_build.html">wwctl image build</a></li>
124125
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_copy.html">wwctl image copy</a></li>

static/docs/main/getting-started/el-quickstart.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@
123123
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_nfs.html">wwctl configure nfs</a></li>
124124
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_ssh.html">wwctl configure ssh</a></li>
125125
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_tftp.html">wwctl configure tftp</a></li>
126+
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_configure_warewulfd.html">wwctl configure warewulfd</a></li>
126127
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image.html">wwctl image</a></li>
127128
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_build.html">wwctl image build</a></li>
128129
<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_image_copy.html">wwctl image copy</a></li>

0 commit comments

Comments
 (0)