diff --git a/docs/main/_sources/contents/boot-management.rst.txt b/docs/main/_sources/contents/boot-management.rst.txt index 62793f0e..1bfa83e6 100644 --- a/docs/main/_sources/contents/boot-management.rst.txt +++ b/docs/main/_sources/contents/boot-management.rst.txt @@ -106,7 +106,7 @@ booted by GRUB. .. code-block:: console - # wwctl container shell leap15.5 + # wwctl container shell leap15.5 [leap15.5] Warewulf> zypper install grub2 shim # wwctl container shell rocky9 diff --git a/docs/main/_sources/contents/dnsmasq.rst.txt b/docs/main/_sources/contents/dnsmasq.rst.txt index e1b97486..ef546211 100644 --- a/docs/main/_sources/contents/dnsmasq.rst.txt +++ b/docs/main/_sources/contents/dnsmasq.rst.txt @@ -5,12 +5,12 @@ Dnsmasq Usage ===== -As experimental feature its possible to use `dnsmasq` instead of the ISC `dhcpd` server in combination -with a `tFTP` server. The `dnsmasq` service is then acting as `dhcp` and `tftp` server. In order to keep -the file `/etc/dnsmasq.d/ww4-hosts.conf` is created and must be included in the main `dnsmasq.conf` via +As experimental feature its possible to use `dnsmasq` instead of the ISC `dhcpd` server in combination +with a `tFTP` server. The `dnsmasq` service is then acting as `dhcp` and `tftp` server. In order to keep +the file `/etc/dnsmasq.d/ww4-hosts.conf` is created and must be included in the main `dnsmasq.conf` via the `conf-dir=/etc/dnsmasq.d` option. -Addionally in the configuration file `warewulf.conf` in the sections `dhcp` and `tftp` the systemd name of +Addionally in the configuration file `warewulf.conf` in the sections `dhcp` and `tftp` the systemd name of dnsmasq must set for the option `systemd name`. After this configuration steps its recommended to rebuild the host overlay with `wwctl overlay build -H` and diff --git a/docs/main/_sources/contents/example-templates.rst.txt b/docs/main/_sources/contents/example-templates.rst.txt index b04f176b..5188346a 100644 --- a/docs/main/_sources/contents/example-templates.rst.txt +++ b/docs/main/_sources/contents/example-templates.rst.txt @@ -7,9 +7,9 @@ The examples directory contains some useful examples for day to day cluster admn Genders ======= -The file `genders.ww` can be placed as `/etc/genders.ww` which will create a genders database which containts all nodes with their profile as key. Also for every user defined 'key' the 'tah' will be added. +The file `genders.ww` can be placed as `/etc/genders.ww` which will create a genders database which containts all nodes with their profile as key. Also for every user defined 'key' the 'tah' will be added. -.. Note: +.. Note: A arbitrary tag with a key can be added to a node with diff --git a/docs/main/_sources/contents/provisioning.rst.txt b/docs/main/_sources/contents/provisioning.rst.txt index c1ba2c14..371ac484 100644 --- a/docs/main/_sources/contents/provisioning.rst.txt +++ b/docs/main/_sources/contents/provisioning.rst.txt @@ -82,12 +82,12 @@ through the following command : # wwctl node status NODENAME STAGE SENT LASTSEEN (s) ================================================================================ - c001 RUNTIME_OVERLAY generic.img.gz 16 + c001 RUNTIME_OVERLAY generic.img.gz 16 For each node, there is 4 different stages : -* **IPXE** +* **IPXE** * **KERNEL** * **SYSTEM_OVERLAY** * **RUNTIME_OVERLAY** @@ -98,4 +98,4 @@ by the wwclient Thanks to ``wwctl node status`` command, you can also check your communication between the warewulf client and server. Depending on your warewulf version, you should see a reset of the last seen counter every 1 minute due to the -warewulf runtime overlay update. \ No newline at end of file +warewulf runtime overlay update. diff --git a/docs/main/_sources/contents/security.rst.txt b/docs/main/_sources/contents/security.rst.txt index b0bb42a8..a53d5dac 100644 --- a/docs/main/_sources/contents/security.rst.txt +++ b/docs/main/_sources/contents/security.rst.txt @@ -77,9 +77,9 @@ In Warewulf there are ways multiple to secure the provisioning process: provision and communicate with requests from that system matching that asset tag. -#. When the nodes are booted via `shim` and `grub` Secure Boot can be - enabled. This means that the nodes only boot the kernel which is - provided by the distributor and also custom complied modules can't +#. When the nodes are booted via `shim` and `grub` Secure Boot can be + enabled. This means that the nodes only boot the kernel which is + provided by the distributor and also custom complied modules can't be loaded. Summary diff --git a/docs/main/_sources/contents/templating.rst.txt b/docs/main/_sources/contents/templating.rst.txt index 98114144..6fa4ee4e 100644 --- a/docs/main/_sources/contents/templating.rst.txt +++ b/docs/main/_sources/contents/templating.rst.txt @@ -216,7 +216,7 @@ A given string can be split into substrings. Node specific files ------------------- -Sometimes there is the need to have specific files for every node +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: diff --git a/docs/main/_sources/contributing/debugging.rst.txt b/docs/main/_sources/contributing/debugging.rst.txt index d32affe0..300baeb8 100644 --- a/docs/main/_sources/contributing/debugging.rst.txt +++ b/docs/main/_sources/contributing/debugging.rst.txt @@ -16,7 +16,7 @@ vet`` on the full codebase. .. code-block:: console $ make vet - + Running the full test suite =========================== diff --git a/docs/main/_sources/contributing/development-environment-vagrant.rst.txt b/docs/main/_sources/contributing/development-environment-vagrant.rst.txt index 4eef2a75..a2445fd3 100644 --- a/docs/main/_sources/contributing/development-environment-vagrant.rst.txt +++ b/docs/main/_sources/contributing/development-environment-vagrant.rst.txt @@ -132,9 +132,9 @@ Vagrantfile netmask: "255.255.255.0", libvirt__network_name: "pxe", libvirt__dhcp_enabled: false - + head.vm.synced_folder ".", "/vagrant", type: "nfs", nfs_version: 4, nfs_udp: false - + head.vm.provider :libvirt do |libvirt| libvirt.cpu_mode = "host-passthrough" libvirt.memory = '8192' @@ -176,12 +176,12 @@ Vagrantfile WWCLIENTDIR=/warewulf make all make install - + systemctl disable --now firewalld sed -i 's/SELINUX=enforcing/SELINUX=disabled/' /etc/selinux/config SHELL - + head.vm.provision "reload" head.vm.provision "shell", inline: <<-SHELL @@ -238,7 +238,7 @@ Vagrantfile node.vm.hostname = "n000#{i}" node.vm.network "private_network", libvirt__network_name: "pxe" - + node.vm.provider :libvirt do |compute| compute.cpu_mode = 'host-passthrough' compute.memory = '8192' diff --git a/docs/main/_sources/index.rst.txt b/docs/main/_sources/index.rst.txt index 9d7a4b8c..cf0f642d 100644 --- a/docs/main/_sources/index.rst.txt +++ b/docs/main/_sources/index.rst.txt @@ -54,7 +54,7 @@ Welcome to the Warewulf User Guide! .. toctree:: :maxdepth: 2 :caption: Reference - :glob: + :glob: reference/* diff --git a/docs/main/_sources/quickstart/debian12.rst.txt b/docs/main/_sources/quickstart/debian12.rst.txt index 51800c3c..ad184339 100644 --- a/docs/main/_sources/quickstart/debian12.rst.txt +++ b/docs/main/_sources/quickstart/debian12.rst.txt @@ -1,5 +1,5 @@ ===================================== -Debian 12 Quickstart +Debian 12 Quickstart ===================================== @@ -13,8 +13,8 @@ Install the basic services .. note:: - If you get an error message concerning *isc-dhcp-server.service* you - probably need to configure the network intarface that isc-dhcp-server + If you get an error message concerning *isc-dhcp-server.service* you + probably need to configure the network intarface that isc-dhcp-server will listen to. Run ``sudo dpkg-reconfigure isc-dhcp-server`` and enter the name of your cluster's private network interface (e.g. enp2s0). After that, you might also need to run ``sudo systemctl enable isc-dhcp-server``. @@ -25,9 +25,9 @@ Install Warewulf and dependencies .. code-block:: bash - + sudo apt install build-essential curl unzip - + sudo apt install git golang libnfs-utils libgpgme-dev libassuan-dev @@ -94,7 +94,7 @@ address of your cluster's private network interface: export options: ro,sync,no_root_squash mount options: defaults mount: false - systemd name: nfs-server + systemd name: nfs-server .. note:: @@ -155,7 +155,7 @@ the ``default`` node profile: .. code-block:: bash sudo wwctl profile set --yes --container debian-12.0 "default" - + Next we set some default networking configurations for the first ethernet device. On modern Linux distributions, the name of the device @@ -200,7 +200,7 @@ typing the following: sudo wwctl node list -a n0000.cluster -To make node changes effective, it is a good practice to update warewulf +To make node changes effective, it is a good practice to update warewulf overlays with the following command: .. code-block:: bash