Update main docs

Author: actions-user

static/docs/main/_sources/overlays/overlays.rst.txt

@@ -25,6 +25,37 @@ within the overlays with ``wwctl overlay list --all``.
    fstab         etc/          false
    fstab         etc/fstab.ww  false
 
+Overlay Variables
+-----------------
+
+The command ``wwctl overlay info`` shows the variables used in an overlay
+template, along with the help text for each variable.
+
+.. code-block:: console
+
+   # wwctl overlay info NetworkManager etc/NetworkManager/system-connections/ww4-managed.ww
+   VARIABLE                        HELP                                           TYPE    OPTION
+   --------                        ----                                           ----    ------
+   $netdev.Device                  Set the device for given network               string  --netdev
+   $netdev.Gateway                 Set the node's network device gateway          IP      --gateway
+   $netdev.Hwaddr                  Set the device's HW address for given network  string  --hwaddr
+   $netdev.Ipaddr                  IPv4 address in given network                  IP      --ipaddr
+   $netdev.Ipaddr6                 IPv4 address in given network                  IP      --ipaddr
+   $netdev.Ipaddr6                 IPv6 address                                   IP      --ipaddr6
+   $netdev.MTU                     Set the mtu                                    string  --mtu
+   $netdev.OnBoot.BoolDefaultTrue  Enable/disable network device (true/false)     WWbool  --onboot
+   $netdev.Tags
+   $netdev.Tags.DNSSEARCH
+   $netdev.Tags.downdelay
+   $netdev.Tags.master
+   $netdev.Tags.miimon
+   $netdev.Tags.mode
+   $netdev.Tags.parent_device
+   $netdev.Tags.updelay
+   $netdev.Tags.vlan_id
+   $netdev.Tags.xmit_hash_policy
+   $netdev.Type                    Set device type of given network               string  --type
+
 Structure
 =========
 
@@ -163,6 +194,7 @@ mode that they have on the Warewulf server. Use ``wwctl overlay chown`` and
    wwctl overlay chown issue /etc/issue.ww root root
    wwctl overlay chmod issue /etc/issue.ww 0644
 
+
 Distribution Overlays
 =====================
 
@@ -373,7 +405,7 @@ provided as an example. In particular, the provided `tstruct.md.ww` demonstrates
 the use of most available template metadata.
 
 .. code-block:: shell
-  
+
    wwctl overlay show --render=<nodename> debug tstruct.md.ww
 
 .. _localtime:

static/docs/main/_sources/overlays/templates.rst.txt

@@ -33,6 +33,28 @@ non-overlay templates as well.
   commands for the ``wwctl power``, ``wwctl sensor``, and ``wwctl console``
   commands.
 
+Template documentation
+======================
+
+Templates can include documentation to be included in the output of ``wwctl overlay info``.
+
+.. code::
+
+   {{/* wwdoc: Your documentation text */}}
+
+Template variables
+==================
+
+Overlay templates have access to a number of variables that provide information
+about the server configuration, the node being provisioned, and all nodes in the
+cluster. An example of the variables available, and their use, is included with
+Warewulf in the ``tstruct.ww`` template of the ``debug`` overlay.
+
+Variables used in an overlay template can be documented by adding a comment to
+the template with the form ``{{/* .My.Var: Your help text */}}``. Variable help
+text defined in a comment replaces that variable's default help text in the
+output of ``wwctl overlay info``.
+
 Template functions
 ==================
 

static/docs/main/_sources/reference/wwctl_node_add.rst.txt

@@ -30,13 +30,14 @@ Options
       --fsname string                set the file system name which must match a partition name
       --fspath string                the mount point of the file system
       --fswipe                       wipe file system at boot
-  -G, --gateway ip                   Set the node's network device gateway
+  -G, --gateway ip                   Set the node's IPv4 network device gateway
+      --gateway6 ip                  Set the node's IPv6 network device gateway
   -h, --help                         help for add
   -H, --hwaddr string                Set the device's HW address for given network
       --image string                 Set image name
   -i, --init string                  Define the init process to boot the image
   -I, --ipaddr ip                    IPv4 address in given network
-      --ipaddr6 ip                   IPv6 address
+      --ipaddr6 ip                   IPv6 address in given network
       --ipmiaddr ip                  Set the IPMI IP address
       --ipmiescapechar string        Set the IPMI escape character (defaults: '~')
       --ipmigateway ip               Set the IPMI gateway
@@ -62,6 +63,7 @@ Options
       --partnumber string            Set the partition number, if not set next free slot is used
       --partsize string              Set the size of the partition, if not set maximal possible size is used
       --parttype string              Set the partition type GUID
+      --prefixlen6 string            Set the networks IPv6 prefix length
   -p, --primarynet string            Set the primary network interface
   -P, --profile strings              Set the node's profile members (comma separated)
       --root string                  Define the rootfs

static/docs/main/_sources/reference/wwctl_node_set.rst.txt

@@ -38,13 +38,14 @@ Options
       --fsname string                set the file system name which must match a partition name
       --fspath string                the mount point of the file system
       --fswipe                       wipe file system at boot
-  -G, --gateway ip                   Set the node's network device gateway
+  -G, --gateway ip                   Set the node's IPv4 network device gateway
+      --gateway6 ip                  Set the node's IPv6 network device gateway
   -h, --help                         help for set
   -H, --hwaddr string                Set the device's HW address for given network
       --image string                 Set image name
   -i, --init string                  Define the init process to boot the image
   -I, --ipaddr ip                    IPv4 address in given network
-      --ipaddr6 ip                   IPv6 address
+      --ipaddr6 ip                   IPv6 address in given network
       --ipmiaddr ip                  Set the IPMI IP address
       --ipmiescapechar string        Set the IPMI escape character (defaults: '~')
       --ipmigateway ip               Set the IPMI gateway
@@ -74,6 +75,7 @@ Options
       --partnumber string            Set the partition number, if not set next free slot is used
       --partsize string              Set the size of the partition, if not set maximal possible size is used
       --parttype string              Set the partition type GUID
+      --prefixlen6 string            Set the networks IPv6 prefix length
   -p, --primarynet string            Set the primary network interface
   -P, --profile strings              Set the node's profile members (comma separated)
       --root string                  Define the rootfs

static/docs/main/_sources/reference/wwctl_overlay.rst.txt

@@ -38,6 +38,7 @@ SEE ALSO
 * :ref:`wwctl overlay delete <wwctl_overlay_delete>` 	 - Delete Warewulf Overlay or files
 * :ref:`wwctl overlay edit <wwctl_overlay_edit>` 	 - Edit or create a file within a Warewulf Overlay
 * :ref:`wwctl overlay import <wwctl_overlay_import>` 	 - Import a file into a Warewulf Overlay
+* :ref:`wwctl overlay info <wwctl_overlay_info>` 	 - Show variables for a template file in an overlay
 * :ref:`wwctl overlay list <wwctl_overlay_list>` 	 - List Warewulf Overlays and files
 * :ref:`wwctl overlay mkdir <wwctl_overlay_mkdir>` 	 - Create a new directory within an Overlay
 * :ref:`wwctl overlay show <wwctl_overlay_show>` 	 - Show (cat) a file within a Warewulf Overlay

static/docs/main/_sources/reference/wwctl_overlay_info.rst.txt

@@ -0,0 +1,39 @@
+.. _wwctl_overlay_info:
+
+wwctl overlay info
+------------------
+
+Show variables for a template file in an overlay
+
+Synopsis
+~~~~~~~~
+
+
+This command will show the variables for a given template file in a given
+overlay.
+
+::
+
+  wwctl overlay info [flags] OVERLAY_NAME FILE_PATH
+
+Options
+~~~~~~~
+
+::
+
+  -h, --help   help for info
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+  -d, --debug                 Run with debugging messages enabled.
+  -v, --verbose               Run with increased verbosity.
+      --warewulfconf string   Set the warewulf configuration file
+
+SEE ALSO
+~~~~~~~~
+
+* :ref:`wwctl overlay <wwctl_overlay>` 	 - Warewulf Overlay Management
+

static/docs/main/_sources/reference/wwctl_profile_add.rst.txt

@@ -28,13 +28,14 @@ Options
       --fsname string               set the file system name which must match a partition name
       --fspath string               the mount point of the file system
       --fswipe                      wipe file system at boot
-  -G, --gateway ip                  Set the node's network device gateway
+  -G, --gateway ip                  Set the node's IPv4 network device gateway
+      --gateway6 ip                 Set the node's IPv6 network device gateway
   -h, --help                        help for add
   -H, --hwaddr string               Set the device's HW address for given network
       --image string                Set image name
   -i, --init string                 Define the init process to boot the image
   -I, --ipaddr ip                   IPv4 address in given network
-      --ipaddr6 ip                  IPv6 address
+      --ipaddr6 ip                  IPv6 address in given network
       --ipmiaddr ip                 Set the IPMI IP address
       --ipmiescapechar string       Set the IPMI escape character (defaults: '~')
       --ipmigateway ip              Set the IPMI gateway
@@ -60,6 +61,7 @@ Options
       --partnumber string           Set the partition number, if not set next free slot is used
       --partsize string             Set the size of the partition, if not set maximal possible size is used
       --parttype string             Set the partition type GUID
+      --prefixlen6 string           Set the networks IPv6 prefix length
   -p, --primarynet string           Set the primary network interface
   -P, --profile strings             Set the node's profile members (comma separated)
       --root string                 Define the rootfs

static/docs/main/_sources/reference/wwctl_profile_set.rst.txt

@@ -32,13 +32,14 @@ Options
       --fsname string               set the file system name which must match a partition name
       --fspath string               the mount point of the file system
       --fswipe                      wipe file system at boot
-  -G, --gateway ip                  Set the node's network device gateway
+  -G, --gateway ip                  Set the node's IPv4 network device gateway
+      --gateway6 ip                 Set the node's IPv6 network device gateway
   -h, --help                        help for set
   -H, --hwaddr string               Set the device's HW address for given network
       --image string                Set image name
   -i, --init string                 Define the init process to boot the image
   -I, --ipaddr ip                   IPv4 address in given network
-      --ipaddr6 ip                  IPv6 address
+      --ipaddr6 ip                  IPv6 address in given network
       --ipmiaddr ip                 Set the IPMI IP address
       --ipmiescapechar string       Set the IPMI escape character (defaults: '~')
       --ipmigateway ip              Set the IPMI gateway
@@ -68,6 +69,7 @@ Options
       --partnumber string           Set the partition number, if not set next free slot is used
       --partsize string             Set the size of the partition, if not set maximal possible size is used
       --parttype string             Set the partition type GUID
+      --prefixlen6 string           Set the networks IPv6 prefix length
   -p, --primarynet string           Set the primary network interface
   -P, --profile strings             Set the node's profile members (comma separated)
       --root string                 Define the rootfs

static/docs/main/contributing/contributing.html

@@ -149,6 +149,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_delete.html">wwctl overlay delete</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_edit.html">wwctl overlay edit</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_import.html">wwctl overlay import</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_info.html">wwctl overlay info</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_list.html">wwctl overlay list</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_mkdir.html">wwctl overlay mkdir</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_show.html">wwctl overlay show</a></li>

static/docs/main/contributing/debugging.html

@@ -144,6 +144,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_delete.html">wwctl overlay delete</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_edit.html">wwctl overlay edit</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_import.html">wwctl overlay import</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_info.html">wwctl overlay info</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_list.html">wwctl overlay list</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_mkdir.html">wwctl overlay mkdir</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../reference/wwctl_overlay_show.html">wwctl overlay show</a></li>