Skip to content

Commit

Permalink
Update main docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 12, 2024
1 parent 8ba2659 commit 4956fe8
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 3 deletions.
43 changes: 42 additions & 1 deletion static/docs/main/_sources/contents/configuration.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ warewulf.conf
=============

The Warewulf configuration exists as follows in the current version of
Warewulf (4.5.2):
Warewulf (4.5.8):

.. code-block:: yaml
Expand Down Expand Up @@ -227,3 +227,44 @@ Directories
The ``/etc/warewulf/ipxe/`` directory contains *text/templates* that
are used by the Warewulf configuration process to configure the
``ipxe`` service.

FirewallD
=========

When using ``firewalld`` with Warewulf, the following services are required to be added for successful node interconnectivity:

.. code-block:: console
firewall-cmd --permanent --add-service=warewulf
firewall-cmd --permanent --add-service=dhcp
firewall-cmd --permanent --add-service=nfs
firewall-cmd --permanent --add-service=tftp
Make sure the ``--reload`` command is ran afterwards:

.. code-block:: console
firewall-cmd --reload
nftables
========

When deploying ``nftables`` with Warewulf, ensure that TCP port ``9873`` for HTTP requests is available, else you will not be able to add new nodes to the cluster.

This can be done with the ``nft add rule`` command:

.. code-block:: console
nft add rule inet filter input tcp dport 9873 accept
Save the changes to your ``nftables.conf`` file:

.. code-block:: console
nft list ruleset > /etc/nftables.conf
Restart the ``nftables`` service:

.. code-block:: console
systemctl restart nftables
34 changes: 33 additions & 1 deletion static/docs/main/contents/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@
<li class="toctree-l2"><a class="reference internal" href="#nodes-conf">nodes.conf</a></li>
<li class="toctree-l2"><a class="reference internal" href="#upgrades">Upgrades</a></li>
<li class="toctree-l2"><a class="reference internal" href="#directories">Directories</a></li>
<li class="toctree-l2"><a class="reference internal" href="#firewalld">FirewallD</a></li>
<li class="toctree-l2"><a class="reference internal" href="#nftables">nftables</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
Expand Down Expand Up @@ -129,7 +131,7 @@ <h1>Warewulf Configuration<a class="headerlink" href="#warewulf-configuration" t
<section id="warewulf-conf">
<h2>warewulf.conf<a class="headerlink" href="#warewulf-conf" title="Link to this heading"></a></h2>
<p>The Warewulf configuration exists as follows in the current version of
Warewulf (4.5.2):</p>
Warewulf (4.5.8):</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">ipaddr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10.0.0.1</span>
<span class="nt">netmask</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">255.255.252.0</span>
<span class="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10.0.0.0</span>
Expand Down Expand Up @@ -317,6 +319,36 @@ <h2>Directories<a class="headerlink" href="#directories" title="Link to this hea
are used by the Warewulf configuration process to configure the
<code class="docutils literal notranslate"><span class="pre">ipxe</span></code> service.</p>
</section>
<section id="firewalld">
<h2>FirewallD<a class="headerlink" href="#firewalld" title="Link to this heading"></a></h2>
<p>When using <code class="docutils literal notranslate"><span class="pre">firewalld</span></code> with Warewulf, the following services are required to be added for successful node interconnectivity:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">firewall-cmd --permanent --add-service=warewulf</span>
<span class="go">firewall-cmd --permanent --add-service=dhcp</span>
<span class="go">firewall-cmd --permanent --add-service=nfs</span>
<span class="go">firewall-cmd --permanent --add-service=tftp</span>
</pre></div>
</div>
<p>Make sure the <code class="docutils literal notranslate"><span class="pre">--reload</span></code> command is ran afterwards:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">firewall-cmd --reload</span>
</pre></div>
</div>
</section>
<section id="nftables">
<h2>nftables<a class="headerlink" href="#nftables" title="Link to this heading"></a></h2>
<p>When deploying <code class="docutils literal notranslate"><span class="pre">nftables</span></code> with Warewulf, ensure that TCP port <code class="docutils literal notranslate"><span class="pre">9873</span></code> for HTTP requests is available, else you will not be able to add new nodes to the cluster.</p>
<p>This can be done with the <code class="docutils literal notranslate"><span class="pre">nft</span> <span class="pre">add</span> <span class="pre">rule</span></code> command:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">nft add rule inet filter input tcp dport 9873 accept</span>
</pre></div>
</div>
<p>Save the changes to your <code class="docutils literal notranslate"><span class="pre">nftables.conf</span></code> file:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">nft list ruleset &gt; /etc/nftables.conf</span>
</pre></div>
</div>
<p>Restart the <code class="docutils literal notranslate"><span class="pre">nftables</span></code> service:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">systemctl restart nftables</span>
</pre></div>
</div>
</section>
</section>


Expand Down
2 changes: 2 additions & 0 deletions static/docs/main/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,8 @@ <h1>User Guide<a class="headerlink" href="#user-guide" title="Link to this headi
<li class="toctree-l2"><a class="reference internal" href="contents/configuration.html#nodes-conf">nodes.conf</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/configuration.html#upgrades">Upgrades</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/configuration.html#directories">Directories</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/configuration.html#firewalld">FirewallD</a></li>
<li class="toctree-l2"><a class="reference internal" href="contents/configuration.html#nftables">nftables</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contents/wwctl.html">Controlling Warewulf (wwctl)</a><ul>
Expand Down
2 changes: 1 addition & 1 deletion static/docs/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 4956fe8

Please sign in to comment.