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 Sep 18, 2024
1 parent a77cb9d commit 684a5e3
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 13 deletions.
11 changes: 8 additions & 3 deletions static/docs/v4.5.x/_sources/contents/nodeconfig.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ provide the network information as follows:

.. code-block:: console
# wwctl node set --netdev eth0 --hwaddr 11:22:33:44:55:66 --ipaddr 10.0.2.1 --netmask 255.255.252.0 n001
# wwctl node set --netdev eno1 --hwaddr 11:22:33:44:55:66 --ipaddr 10.0.2.1 --netmask 255.255.252.0 n001
Are you sure you want to modify 1 nodes(s): y
You can now see that the node contains configuration attributes for
Expand Down Expand Up @@ -212,7 +212,7 @@ container, kernel, and network:
n001 profile -- default
n001 default:type -- (ethernet)
n001 default:onboot -- --
n001 default:netdev -- eth0
n001 default:netdev -- eno1
n001 default:hwaddr -- 11:22:33:44:55:66
n001 default:ipaddr -- 10.0.2.1
n001 default:ipaddr6 -- --
Expand All @@ -227,8 +227,13 @@ container, kernel, and network:
# wwctl node list -a n001 | grep cluster
n001 cluster -- cluster01
.. note::
Due to the way network interface names are assigned by the Linux kernel and overwritten by udev
and systemd in the default warewulf configuration, the use of `eth0/1/...` as interface names can lead to issues.
We recommend the use of the original predictable names assigned to the interfaces (`eno1, ...`),
as otherwise an interface may remain unconfigured if its name conflicts with the name of an already existing interface during boot.

To configure a bonded (link aggreagtion) network interface the following commands can be used:
To configure a bonded (link aggregation) network interface the following commands can be used:

.. code-block:: console
Expand Down
6 changes: 3 additions & 3 deletions static/docs/v4.5.x/_sources/contents/overlays.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ network configurations for
* NetworkManager
* EL legacy network scripts

it also contains udev rules, which will set the interface name of the
first network device to ``eth0``. Before the ``systemd`` init is
called, the overlay loops through the scripts in
it also contains udev rules, which will set the interface names
based on the hardware addresses configured for the node.
Before the ``systemd`` init is called, the overlay loops through the scripts in
``/wwinit/warwulf/init.d/*`` which will setup

* Ipmi
Expand Down
13 changes: 10 additions & 3 deletions static/docs/v4.5.x/contents/nodeconfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ <h3>Configuring the Node’s Kernel<a class="headerlink" href="#configuring-the-
<h3>Configuring the Node’s Network<a class="headerlink" href="#configuring-the-node-s-network" title="Link to this heading"></a></h3>
<p>To configure the network, we have to pick a network device name and
provide the network information as follows:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>wwctl<span class="w"> </span>node<span class="w"> </span><span class="nb">set</span><span class="w"> </span>--netdev<span class="w"> </span>eth0<span class="w"> </span>--hwaddr<span class="w"> </span><span class="m">11</span>:22:33:44:55:66<span class="w"> </span>--ipaddr<span class="w"> </span><span class="m">10</span>.0.2.1<span class="w"> </span>--netmask<span class="w"> </span><span class="m">255</span>.255.252.0<span class="w"> </span>n001
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>wwctl<span class="w"> </span>node<span class="w"> </span><span class="nb">set</span><span class="w"> </span>--netdev<span class="w"> </span>eno1<span class="w"> </span>--hwaddr<span class="w"> </span><span class="m">11</span>:22:33:44:55:66<span class="w"> </span>--ipaddr<span class="w"> </span><span class="m">10</span>.0.2.1<span class="w"> </span>--netmask<span class="w"> </span><span class="m">255</span>.255.252.0<span class="w"> </span>n001
<span class="go"> Are you sure you want to modify 1 nodes(s): y</span>
</pre></div>
</div>
Expand Down Expand Up @@ -314,7 +314,7 @@ <h3>Configuring the Node’s Network<a class="headerlink" href="#configuring-the
<span class="go">n001 profile -- default</span>
<span class="go">n001 default:type -- (ethernet)</span>
<span class="go">n001 default:onboot -- --</span>
<span class="go">n001 default:netdev -- eth0</span>
<span class="go">n001 default:netdev -- eno1</span>
<span class="go">n001 default:hwaddr -- 11:22:33:44:55:66</span>
<span class="go">n001 default:ipaddr -- 10.0.2.1</span>
<span class="go">n001 default:ipaddr6 -- --</span>
Expand All @@ -330,7 +330,14 @@ <h3>Configuring the Node’s Network<a class="headerlink" href="#configuring-the
<span class="go">n001 cluster -- cluster01</span>
</pre></div>
</div>
<p>To configure a bonded (link aggreagtion) network interface the following commands can be used:</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Due to the way network interface names are assigned by the Linux kernel and overwritten by udev
and systemd in the default warewulf configuration, the use of <cite>eth0/1/…</cite> as interface names can lead to issues.
We recommend the use of the original predictable names assigned to the interfaces (<cite>eno1, …</cite>),
as otherwise an interface may remain unconfigured if its name conflicts with the name of an already existing interface during boot.</p>
</div>
<p>To configure a bonded (link aggregation) network interface the following commands can be used:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>wwctl<span class="w"> </span>node<span class="w"> </span><span class="nb">set</span><span class="w"> </span>--netname<span class="o">=</span>bond0_member_1<span class="w"> </span>--netdev<span class="o">=</span>eth2<span class="w"> </span>--type<span class="o">=</span>bond-slave<span class="w"> </span>n001
<span class="gp"># </span>wwctl<span class="w"> </span>node<span class="w"> </span><span class="nb">set</span><span class="w"> </span>--netname<span class="o">=</span>bond0_member_2<span class="w"> </span>--netdev<span class="o">=</span>eth3<span class="w"> </span>--type<span class="o">=</span>bond-slave<span class="w"> </span>n001
<span class="gp"># </span>wwctl<span class="w"> </span>node<span class="w"> </span><span class="nb">set</span><span class="w"> </span>--netname<span class="o">=</span>bond0<span class="w"> </span>--netdev<span class="o">=</span>bond0<span class="w"> </span>--onboot<span class="o">=</span><span class="nb">true</span><span class="w"> </span>--type<span class="o">=</span>bond<span class="w"> </span>--ipaddr<span class="w"> </span><span class="m">10</span>.0.3.1<span class="w"> </span>--netmask<span class="o">=</span><span class="m">255</span>.255.255.0<span class="w"> </span>--mtu<span class="o">=</span><span class="m">9000</span><span class="w"> </span>n001
Expand Down
6 changes: 3 additions & 3 deletions static/docs/v4.5.x/contents/overlays.html
Original file line number Diff line number Diff line change
Expand Up @@ -173,9 +173,9 @@ <h3>System or wwinit overlay<a class="headerlink" href="#system-or-wwinit-overla
<li><p>NetworkManager</p></li>
<li><p>EL legacy network scripts</p></li>
</ul>
<p>it also contains udev rules, which will set the interface name of the
first network device to <code class="docutils literal notranslate"><span class="pre">eth0</span></code>. Before the <code class="docutils literal notranslate"><span class="pre">systemd</span></code> init is
called, the overlay loops through the scripts in
<p>it also contains udev rules, which will set the interface names
based on the hardware addresses configured for the node.
Before the <code class="docutils literal notranslate"><span class="pre">systemd</span></code> init is called, the overlay loops through the scripts in
<code class="docutils literal notranslate"><span class="pre">/wwinit/warwulf/init.d/*</span></code> which will setup</p>
<ul class="simple">
<li><p>Ipmi</p></li>
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 684a5e3

Please sign in to comment.