Skip to content

Commit

Permalink
Update v4.5.x docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed May 6, 2024
1 parent 175e65a commit a659495
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 1 deletion.
25 changes: 25 additions & 0 deletions static/docs/v4.5.x/_sources/contents/configuration.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ Warewulf (4.5.1):
- source: /etc/resolv.conf
dest: /etc/resolv.conf
readonly: true
ssh:
key types:
- rsa
- dsa
- ecdsa
- ed25519
Generally you can leave this file as is, as long as you set the
appropriate networking information. Specifically the following
Expand Down Expand Up @@ -151,6 +157,25 @@ may be overridden using ``warewulf.conf:paths``.

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

SSH key types
-------------

*New in Warewulf v4.5.1*

SSH key types to generate during ``wwctl configure ssh`` may be overridden using ``warewulf.conf:ssh:key types``.

.. code-block:: yaml
ssh:
key types:
- rsa
- dsa
- ecdsa
- ed25519
Warewulf will generate host keys for each listed key type.
The first listed key type is used to generate authentication ssh keys.

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

Expand Down
22 changes: 22 additions & 0 deletions static/docs/v4.5.x/contents/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
<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><ul>
<li class="toctree-l3"><a class="reference internal" href="#paths">Paths</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ssh-key-types">SSH key types</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#nodes-conf">nodes.conf</a></li>
Expand Down Expand Up @@ -164,6 +165,12 @@ <h2>warewulf.conf<a class="headerlink" href="#warewulf-conf" title="Link to this
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">source</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/resolv.conf</span>
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/resolv.conf</span>
<span class="w"> </span><span class="nt">readonly</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
<span class="nt">ssh</span><span class="p">:</span>
<span class="w"> </span><span class="nt">key types</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">rsa</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dsa</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ecdsa</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ed25519</span>
</pre></div>
</div>
<p>Generally you can leave this file as is, as long as you set the
Expand Down Expand Up @@ -248,6 +255,21 @@ <h3>Paths<a class="headerlink" href="#paths" title="Link to this heading"></a
<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 id="ssh-key-types">
<h3>SSH key types<a class="headerlink" href="#ssh-key-types" title="Link to this heading"></a></h3>
<p><em>New in Warewulf v4.5.1</em></p>
<p>SSH key types to generate during <code class="docutils literal notranslate"><span class="pre">wwctl</span> <span class="pre">configure</span> <span class="pre">ssh</span></code> may be overridden using <code class="docutils literal notranslate"><span class="pre">warewulf.conf:ssh:key</span> <span class="pre">types</span></code>.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">ssh</span><span class="p">:</span>
<span class="w"> </span><span class="nt">key types</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">rsa</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dsa</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ecdsa</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ed25519</span>
</pre></div>
</div>
<p>Warewulf will generate host keys for each listed key type.
The first listed key type is used to generate authentication ssh keys.</p>
</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/v4.5.x/searchindex.js

Large diffs are not rendered by default.

0 comments on commit a659495

Please sign in to comment.