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 10, 2024
1 parent e945299 commit f837947
Show file tree
Hide file tree
Showing 10 changed files with 48 additions and 36 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<map id="G" name="G">
</map>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<map id="G" name="G">
</map>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<map id="foo" name="foo">
</map>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<map id="G" name="G">
</map>
56 changes: 28 additions & 28 deletions static/docs/main/_sources/contents/setup.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Here is an example of how the cluster's address can be divided for a
Multiple networks
=================

It is possible to configure several networks not just for the nodes but also for the management of ``dhcpd`` and ``tftp``.
It is possible to configure several networks not just for the nodes but also for the management of ``dhcpd`` and ``tftp``.
There are two ways to achive this:

1. Add the networks to the templates of ``dhcpd`` and/or the ``dnsmasq`` template directly.
Expand Down Expand Up @@ -113,33 +113,33 @@ You can check the result with ``wwctl node list``.
.. code-block:: console
# wwctl node list -a deliverynet
NODE FIELD PROFILE VALUE
deliverynet Id -- deliverynet
deliverynet Comment default This profile is automatically included for each node
deliverynet ContainerName default leap15.5
deliverynet Ipxe -- (default)
deliverynet RuntimeOverlay -- (generic)
deliverynet SystemOverlay -- (wwinit)
deliverynet Root -- (initramfs)
deliverynet Init -- (/sbin/init)
deliverynet Kernel.Args -- (quiet crashkernel=no vga=791 net.naming-scheme=v238)
deliverynet Profiles -- default
deliverynet PrimaryNetDev -- (deliver1)
deliverynet NetDevs[deliver2].Type -- (ethernet)
deliverynet NetDevs[deliver2].OnBoot -- (true)
deliverynet NetDevs[deliver2].Ipaddr -- 10.0.30.250
deliverynet NetDevs[deliver2].Netmask -- 255.255.255.0
deliverynet NetDevs[deliver2].Tags[dynend] -- 10.10.30.50
deliverynet NetDevs[deliver2].Tags[dynstart] -- 10.10.30.10
deliverynet NetDevs[deliver2].Tags[network] -- 10.0.30.0
deliverynet NetDevs[deliver1].Type -- (ethernet)
deliverynet NetDevs[deliver1].OnBoot -- (true)
deliverynet NetDevs[deliver1].Ipaddr -- 10.0.20.250
deliverynet NetDevs[deliver1].Netmask -- 255.255.255.0
deliverynet NetDevs[deliver1].Primary -- (true)
deliverynet NetDevs[deliver1].Tags[network] -- 10.0.20.0
deliverynet NetDevs[deliver1].Tags[dynend] -- 10.10.20.50
deliverynet NetDevs[deliver1].Tags[dynstart] -- 10.10.20.10
NODE FIELD PROFILE VALUE
deliverynet Id -- deliverynet
deliverynet Comment default This profile is automatically included for each node
deliverynet ContainerName default leap15.5
deliverynet Ipxe -- (default)
deliverynet RuntimeOverlay -- (generic)
deliverynet SystemOverlay -- (wwinit)
deliverynet Root -- (initramfs)
deliverynet Init -- (/sbin/init)
deliverynet Kernel.Args -- (quiet crashkernel=no vga=791 net.naming-scheme=v238)
deliverynet Profiles -- default
deliverynet PrimaryNetDev -- (deliver1)
deliverynet NetDevs[deliver2].Type -- (ethernet)
deliverynet NetDevs[deliver2].OnBoot -- (true)
deliverynet NetDevs[deliver2].Ipaddr -- 10.0.30.250
deliverynet NetDevs[deliver2].Netmask -- 255.255.255.0
deliverynet NetDevs[deliver2].Tags[dynend] -- 10.10.30.50
deliverynet NetDevs[deliver2].Tags[dynstart] -- 10.10.30.10
deliverynet NetDevs[deliver2].Tags[network] -- 10.0.30.0
deliverynet NetDevs[deliver1].Type -- (ethernet)
deliverynet NetDevs[deliver1].OnBoot -- (true)
deliverynet NetDevs[deliver1].Ipaddr -- 10.0.20.250
deliverynet NetDevs[deliver1].Netmask -- 255.255.255.0
deliverynet NetDevs[deliver1].Primary -- (true)
deliverynet NetDevs[deliver1].Tags[network] -- 10.0.20.0
deliverynet NetDevs[deliver1].Tags[dynend] -- 10.10.20.50
deliverynet NetDevs[deliver1].Tags[dynstart] -- 10.10.20.10
Now the templates of ``dhcpd`` and/or ``dnsmasq`` must be modified.
You can edit the configuration files.
Expand Down
20 changes: 12 additions & 8 deletions static/docs/main/contents/boot-management.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h1>Boot Management<a class="headerlink" href="#boot-management" title="Link to
for GRUB is also available, which adds support for secure boot.</p>
<section id="booting-with-ipxe">
<h2>Booting with iPXE<a class="headerlink" href="#booting-with-ipxe" title="Link to this heading"></a></h2>
digraph G{
<div class="graphviz"><img src="../_images/graphviz-8be43717679b33953ee198ed82f1999c0ddd0b61.png" alt="digraph G{
node [shape=box];
compound=true;
edge [label2node=true]
Expand All @@ -144,12 +144,13 @@ <h2>Booting with iPXE<a class="headerlink" href="#booting-with-ipxe" title="Link
kernel [shape=record label=&quot;{kernel|ramdisk (root fs)|wwinit overlay}|extracted from node container&quot;];
ipxe_cfg-&gt;kernel[ltail=cluster0,label=&quot;http&quot;];
}</section>
}" class="graphviz" /></div>
</section>
<section id="booting-with-grub">
<h2>Booting with GRUB<a class="headerlink" href="#booting-with-grub" title="Link to this heading"></a></h2>
<p>Support for GRUB as a network bootloader (replacing iPXE) is available in
Warewulf as a technology preview.</p>
digraph G{
<div class="graphviz"><img src="../_images/graphviz-5cb5701ea7fd182b13828ac567d21b2e09945929.png" alt="digraph G{
node [shape=box];
compound=true;
edge [label2node=true]
Expand All @@ -166,7 +167,8 @@ <h2>Booting with GRUB<a class="headerlink" href="#booting-with-grub" title="Link
}
kernel [shape=record label=&quot;{kernel|ramdisk (root fs)|wwinit overlay}|extracted from node container&quot;];
grubcfg-&gt;kernel[ltail=cluster1,label=&quot;http&quot;];
}<p>Instead of the iPXE starter a combination of <a class="reference external" href="https://www.suse.com/c/uefi-secure-boot-details/">shim and GRUB</a> can be used with the
}" class="graphviz" /></div>
<p>Instead of the iPXE starter a combination of <a class="reference external" href="https://www.suse.com/c/uefi-secure-boot-details/">shim and GRUB</a> can be used with the
advantage that secure boot can be used. That means that only the signed kernel
of a distribution can be booted. This can be a huge security benefit for some
scenarios.</p>
Expand All @@ -175,7 +177,7 @@ <h2>Booting with GRUB<a class="headerlink" href="#booting-with-grub" title="Link
Warewulf server host.</p>
<section id="secure-boot">
<h3>Secure boot<a class="headerlink" href="#secure-boot" title="Link to this heading"></a></h3>
digraph foo {
<div class="graphviz"><img src="../_images/graphviz-87f2b5a9fa342f42cc8028f4a60d24c3ea795fd3.png" alt="digraph foo {
node [shape=box];
subgraph boot {
&quot;EFI&quot; [label=&quot;EFI&quot;,row=boot];
Expand All @@ -186,7 +188,8 @@ <h3>Secure boot<a class="headerlink" href="#secure-boot" title="Link to this hea
Shim -&gt; Grub[label=&quot;Check for Distribution signature&quot;];
Grub-&gt;Kernel[label=&quot;Check for Distribution or MOK signature&quot;];
}
}<p>If secure boot is enabled at every step a signature is checked and the boot
}" class="graphviz" /></div>
<p>If secure boot is enabled at every step a signature is checked and the boot
process fails if this check fails. The shim typically only includes the key for
a single operating system, which means that each distribution needs separate
<cite>shim</cite> and <cite>grub</cite> executables. Warewulf extracts these binaries from the
Expand All @@ -212,7 +215,7 @@ <h3>Install shim and efi<a class="headerlink" href="#install-shim-and-efi" title
<h3>http boot<a class="headerlink" href="#http-boot" title="Link to this heading"></a></h3>
<p>Modern EFI systems have the possibility to directly boot per http. The flow diagram
is the following:</p>
digraph G{
<div class="graphviz"><img src="../_images/graphviz-45530e0b437388de246c86a5b4638e7b3654235b.png" alt="digraph G{
node [shape=box];
efi [shape=record label=&quot;{EFI|boots from URI defined in filename}&quot;];
shim [shape=record label=&quot;{shim.efi|replaces shim.efi with grubx64.efi in URI|extracted from node container}&quot;];
Expand All @@ -221,7 +224,8 @@ <h3>http boot<a class="headerlink" href="#http-boot" title="Link to this heading
efi-&gt;shim [label=&quot;http&quot;];
shim-&gt;grub [label=&quot;http&quot;];
grub-&gt;kernel [label=&quot;http&quot;];
}<p>Warewulf delivers the initial <cite>shim.efi</cite> and <cite>grub.efi</cite> via http as taken
}" class="graphviz" /></div>
<p>Warewulf delivers the initial <cite>shim.efi</cite> and <cite>grub.efi</cite> via http as taken
directly from the node’s assigned container.</p>
</section>
</section>
Expand Down

0 comments on commit f837947

Please sign in to comment.