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 Mar 26, 2024
1 parent 650383a commit 0a5a937
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 4 deletions.
35 changes: 34 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.4.0):
Warewulf (4.5.0):

.. code-block:: yaml
Expand Down Expand Up @@ -118,6 +118,39 @@ explained as follows:
during ``container exec`` or ``container shell``, typically to allow
them to operate in the host environment prior to deployment.

Paths
-----

*New in Warewulf v4.5.0*

Default paths to containers, overlays, and other Warewulf components
may be overridden using ``warewulf.conf:paths``.

.. code-block:: yaml
paths:
sysconfdir: /etc
localstatedir: /var/lib
ipxesource: /usr/share/ipxe
wwoverlaydir: /var/lib/warewulf/overlays
wwchrootdir: /var/lib/warewulf/chroots
wwprovisiondir: /var/lib/warewulf/provision
wwclientdir: /warewulf
* ``sysconfdir``: The parent directory for the ``warewulf`` configuration directory,
which stores ``warewulf.conf`` and ``nodes.conf``.

* ``ipxesource``: Where to get iPXE binaries.
These files are copied to ``warewulf.conf:tftp:tftproot`` by ``wwctl configure``.

* ``wwoverlaydir``: The source for Warewulf overlays.

* ``wwchrootdir``: The source for Warewulf containers.

* ``wwprovisiondir``: Where to store built overlays, built containers, and imported kernels.

* ``wwclientdir``: Where the Warewulf client looks for its configuration on a provisioned node.

nodes.conf
==========

Expand Down
33 changes: 31 additions & 2 deletions static/docs/main/contents/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,10 @@
<li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Warewulf Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#warewulf-conf">warewulf.conf</a></li>
<li class="toctree-l2"><a class="reference internal" href="#warewulf-conf">warewulf.conf</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#paths">Paths</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#nodes-conf">nodes.conf</a></li>
<li class="toctree-l2"><a class="reference internal" href="#defaults-conf">defaults.conf</a></li>
<li class="toctree-l2"><a class="reference internal" href="#directories">Directories</a></li>
Expand Down Expand Up @@ -125,7 +128,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.4.0):</p>
Warewulf (4.5.0):</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">WW_INTERNAL</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">45</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>
Expand Down Expand Up @@ -219,6 +222,32 @@ <h2>warewulf.conf<a class="headerlink" href="#warewulf-conf" title="Link to this
during <code class="docutils literal notranslate"><span class="pre">container</span> <span class="pre">exec</span></code> or <code class="docutils literal notranslate"><span class="pre">container</span> <span class="pre">shell</span></code>, typically to allow
them to operate in the host environment prior to deployment.</p></li>
</ul>
<section id="paths">
<h3>Paths<a class="headerlink" href="#paths" title="Link to this heading"></a></h3>
<p><em>New in Warewulf v4.5.0</em></p>
<p>Default paths to containers, overlays, and other Warewulf components
may be overridden using <code class="docutils literal notranslate"><span class="pre">warewulf.conf:paths</span></code>.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">paths</span><span class="p">:</span>
<span class="w"> </span><span class="nt">sysconfdir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc</span>
<span class="w"> </span><span class="nt">localstatedir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/var/lib</span>
<span class="w"> </span><span class="nt">ipxesource</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/usr/share/ipxe</span>
<span class="w"> </span><span class="nt">wwoverlaydir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/var/lib/warewulf/overlays</span>
<span class="w"> </span><span class="nt">wwchrootdir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/var/lib/warewulf/chroots</span>
<span class="w"> </span><span class="nt">wwprovisiondir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/var/lib/warewulf/provision</span>
<span class="w"> </span><span class="nt">wwclientdir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/warewulf</span>
</pre></div>
</div>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sysconfdir</span></code>: The parent directory for the <code class="docutils literal notranslate"><span class="pre">warewulf</span></code> configuration directory,
which stores <code class="docutils literal notranslate"><span class="pre">warewulf.conf</span></code> and <code class="docutils literal notranslate"><span class="pre">nodes.conf</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ipxesource</span></code>: Where to get iPXE binaries.
These files are copied to <code class="docutils literal notranslate"><span class="pre">warewulf.conf:tftp:tftproot</span></code> by <code class="docutils literal notranslate"><span class="pre">wwctl</span> <span class="pre">configure</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">wwoverlaydir</span></code>: The source for Warewulf overlays.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">wwchrootdir</span></code>: The source for Warewulf containers.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">wwprovisiondir</span></code>: Where to store built overlays, built containers, and imported kernels.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">wwclientdir</span></code>: Where the Warewulf client looks for its configuration on a provisioned node.</p></li>
</ul>
</section>
</section>
<section id="nodes-conf">
<h2>nodes.conf<a class="headerlink" href="#nodes-conf" title="Link to this heading"></a></h2>
Expand Down
2 changes: 1 addition & 1 deletion static/docs/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 0a5a937

Please sign in to comment.