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 Feb 17, 2024
1 parent 7ee6873 commit 18a0265
Show file tree
Hide file tree
Showing 51 changed files with 518 additions and 1,107 deletions.
2 changes: 1 addition & 1 deletion static/docs/main/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0fa06d080c0cae2897bee13f581904ab
config: 000aa872ae49209e7dd10d9c94d85f7f
tags: 645f666f9bcd5a90fca523b33c5a78b7
6 changes: 3 additions & 3 deletions static/docs/main/_sources/contents/disks.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
===============
/Exa===============
Disk Management
===============

Expand Down Expand Up @@ -61,8 +61,8 @@ required by the enabled `ww4-disks.target`. Entries in `/etc/fstab`
are created with the `no_auto` option so that file systems can be
easily mounted.

Example
=======
Example disk configuration
==========================

The following command will create a `/scratch` file system on the node
`n01`
Expand Down
25 changes: 0 additions & 25 deletions static/docs/main/_sources/contents/example-templates.rst.txt

This file was deleted.

42 changes: 21 additions & 21 deletions static/docs/main/_sources/contents/ipmi.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,27 +25,27 @@ Here is a table outlining the fields on a Profile and Node which is
the same as the parameter that can be used when running ``wwctl
profile set`` or ``wwctl node set``.

+--------------------+---------+------+--------------------+---------------+
| Parameter | Profile | Node | Valid Values | Default Value |
+====================+=========+======+====================+===============+
| ``--ipmiaddr`` | false | true | | |
+--------------------+---------+------+--------------------+---------------+
| ``--ipminetmask`` | true | true | | |
+--------------------+---------+------+--------------------+---------------+
| ``--ipmiport`` | true | true | | 623 |
+--------------------+---------+------+--------------------+---------------+
| ``--ipmigateway`` | true | true | | |
+--------------------+---------+------+--------------------+---------------+
| ``--ipmiuser`` | true | true | | |
+--------------------+---------+------+--------------------+---------------+
| ``--ipmipass`` | true | true | | |
+--------------------+---------+------+--------------------+---------------+
| ``--ipmiinterface``| true | true | 'lan' or 'lanplus' | lan |
+--------------------+---------+------+--------------------+---------------+
| ``--ipmiwrite`` | true | true | true or false | false |
+--------------------+---------+------+--------------------+---------------+
| ``--ipmiescapechar | true | true | single character | ~ |
+--------------------+---------+------+--------------------+---------------+
+----------------------+---------+------+--------------------+---------------+
| Parameter | Profile | Node | Valid Values | Default Value |
+======================+=========+======+====================+===============+
| ``--ipmiaddr`` | false | true | | |
+----------------------+---------+------+--------------------+---------------+
| ``--ipminetmask`` | true | true | | |
+----------------------+---------+------+--------------------+---------------+
| ``--ipmiport`` | true | true | | 623 |
+----------------------+---------+------+--------------------+---------------+
| ``--ipmigateway`` | true | true | | |
+----------------------+---------+------+--------------------+---------------+
| ``--ipmiuser`` | true | true | | |
+----------------------+---------+------+--------------------+---------------+
| ``--ipmipass`` | true | true | | |
+----------------------+---------+------+--------------------+---------------+
| ``--ipmiinterface`` | true | true | 'lan' or 'lanplus' | lan |
+----------------------+---------+------+--------------------+---------------+
| ``--ipmiwrite`` | true | true | true or false | false |
+----------------------+---------+------+--------------------+---------------+
| ``--ipmiescapechar`` | true | true | single character | ~ |
+----------------------+---------+------+--------------------+---------------+


Reviewing Settings
Expand Down
7 changes: 3 additions & 4 deletions static/docs/main/_sources/contents/provisioning.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,9 @@ occur:
a unified root file system
#. Warewulf bootstraps the initialization of cluster node's
operating system
#. File System (re)configuration
#. SELinux
#. ``wwclient`` is called as a background daemon and sleeps
until network is ready
#. File System (re)configuration
#. SELinux
#. ``wwclient`` is called as a background daemon and sleeps until network is ready
#. The Warewulf bootstrap execs the container's ``/sbin/init``
#. Container:
#. The container now boots exactly as any operating system would
Expand Down
4 changes: 2 additions & 2 deletions static/docs/main/_sources/contents/stateless.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ available when Warewulf was created and while these tools absolutely
helped, there was even more optimization to be had. Stateless
computing.

Stateless Provisioning
======================
Why Stateless Provisioning
==========================

The next step past automated installs is to just skip the installation
completely; boot directly into the runtime operating system without
Expand Down
23 changes: 11 additions & 12 deletions static/docs/main/_sources/contents/templating.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Examples
Comment
-------

.. code-block:: go
.. code-block::
{{ /* This comment won't show up in file, but an empty line /* }}
{{ /* No empty line, line break removed at end of this line /* -}}
Expand All @@ -30,7 +30,7 @@ Range

iterate over elements of an array

.. code-block:: go
.. code-block::
{{ range $devname, $netdev := .NetDevs }}
# netdev = {{ $netdev.Hwaddr }}
Expand All @@ -41,7 +41,7 @@ Increment Variable In Loop

iterate over elements of an array and increment ``i`` each loop cycle

.. code-block:: go
.. code-block::
{{ $i := 0 }}
{{ range $devname, $netdev := .NetDevs }}
Expand All @@ -54,7 +54,7 @@ Decrement

iterate over elements of an array and decrement ``i`` each loop cycle

.. code-block:: go
.. code-block::
{{ $i := 10 }}
{{ range $devname, $netdev := .NetDevs }}
Expand All @@ -67,7 +67,7 @@ Access Tag

Acces the value of an individual tag ``foo``

.. code-block:: go
.. code-block::
foo: {{ index .Tags "foo" }}
{{ if eq (index .Tags "foo") "baar" -}}
Expand All @@ -80,7 +80,7 @@ Create Multiple Files
The following template will create a file called
``ifcfg-NETWORKNAME.xml`` for every network present on the node

.. code-block:: go
.. code-block::
{{- $host := .BuildHost }}
{{- $time := .BuildTime }}
Expand Down Expand Up @@ -143,7 +143,7 @@ Include

A file from the host can be include with following template

.. code-block:: go
.. code-block::
{{ Include file }}
Expand All @@ -152,7 +152,7 @@ IncludeFrom

With following snippet a file from a given container can be included

.. code-block:: go
.. code-block::
{{ IncludeFrom container file }}
Expand All @@ -164,7 +164,7 @@ useful, e.g., for the hosts file, which can have local modifications
which are not controlled by warewulf. For this example the abort
string is "# Do not edit after this line"

.. code-block:: go
.. code-block::
{{ IncludeBlock "/etc/hosts" "# Do not edit after this line" }}
# This block is autogenerated by warewulf
Expand Down Expand Up @@ -206,7 +206,7 @@ Split

A given string can be split into substrings.

.. code-block:: go
.. code-block::
{{ $x := "a:b:c" -}}
{{ $y := (split $x ":") -}}
Expand All @@ -220,8 +220,7 @@ Sometimes there is the need to have specific files for every node
which can't be generated by a template. You can include these files
with following template:

.. code-block:: go
.. code-block::
{{- $filename := print "/root/" .Id "-payload" }}
{{ Include $filename }}
4 changes: 2 additions & 2 deletions static/docs/main/_sources/contributing/debugging.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ Read about other commands available within delve using the ``help``
command.


Example
-------
Example debugging session
-------------------------

.. code-block:: console
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Turn off default network dhcp on server master1
Build and install Warewulf on wwdev
===================================

.. code-block:: bash
.. code-block::
ssh wwdev
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
=============================
=================================
Development Environment (Vagrant)
=============================
=================================

Create Rocky Linux 9 virtual machine for Warewulf testbed using Vagrant


Host system requirements
=====================
========================

#. CPU supports H/W virtualization.
#. KVM kernel module available and loaded.


CPU H/W Virtualization support
--------------------------------
------------------------------

Check CPU virtualization capability using following command. If your system has Intel CPU, you will see :code:`Intel VT` here, and if your system has AMD CPU, you will see :code:`AMD-V` here.
Check CPU virtualization capability using following command.
If your system has Intel CPU, you will see :code:`Intel VT` here, and if your system has AMD CPU, you will see :code:`AMD-V` here.

.. code-block:: bash
Expand All @@ -23,9 +25,8 @@ Check CPU virtualization capability using following command. If your system has
Virtualization type: full
KVM kernel module
---------------------
-----------------

.. code-block:: bash
Expand All @@ -36,10 +37,10 @@ KVM kernel module
Setup development environment on Rocky Linux 9
==============================================================
==============================================

Install QEMU, libvirt
-----------------------
---------------------

.. code-block:: bash
Expand All @@ -54,8 +55,9 @@ Install QEMU, libvirt
# Add user to libvirt group
sudo usermod -aG libvirt rocky
Install Cockpit (Optional)
-----------------
--------------------------

.. code-block:: bash
Expand All @@ -65,8 +67,9 @@ Install Cockpit (Optional)
# Enable and start cockpit (http://localhost:9090)
sudo systemctl enable --now cockpit.socket
Install Vagrant, vagrant-libvirt plug-in and vagrant-reload plug-in
---------------------------------------------------------------------
-------------------------------------------------------------------

.. code-block:: bash
Expand All @@ -82,10 +85,10 @@ Install Vagrant, vagrant-libvirt plug-in and vagrant-reload plug-in
Vagrant box and Vagrantfile for Warewulf sandbox
===================================================
================================================

Create Rocky Linux 9.2 vagrant box
------------------------------------
----------------------------------

.. code-block:: bash
Expand All @@ -109,8 +112,9 @@ Create Rocky Linux 9.2 vagrant box
vagrant box add box-metadata.json
Vagrantfile
------------
-----------
.. code-block:: bash
Expand Down Expand Up @@ -251,18 +255,17 @@ Vagrantfile
end
EOF
Spin up head node
===================
=================
.. code-block:: bash
vagrant up
Spin up compute nodes
=======================
=====================
.. code-block:: bash
Expand All @@ -271,4 +274,3 @@ Spin up compute nodes
# Wait until n0001 becomes ready
vagrant up n0002
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ I have VirtualBox running on my desktop.
3. Build and install Warewulf on wwdev

.. code-block:: console
.. code-block::
# Login to wwdev VM and install @development group and go language
Expand Down
2 changes: 1 addition & 1 deletion static/docs/main/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ Welcome to the Warewulf User Guide!
Disk Management <contents/disks>
Security <contents/security>
Templating <contents/templating>
dnsmasq <contents/dnsmasq>

.. toctree::
:maxdepth: 2
:caption: Quickstart

EL7 (CentOS and RHEL) <quickstart/el7>
EL8 (Rocky Linux and RHEL) <quickstart/el8>
EL9 (Rocky Linux and RHEL) <quickstart/el9>
openSUSE Leap and SLES 15 <quickstart/suse15>
Expand Down
Loading

0 comments on commit 18a0265

Please sign in to comment.