Update main docs

static/docs/main/_sources/contents/configuration.rst.txt

@@ -14,7 +14,6 @@ Warewulf (4.5.2):
 
 .. code-block:: yaml
 
-   WW_INTERNAL: 45
    ipaddr: 10.0.0.1
    netmask: 255.255.252.0
    network: 10.0.0.0
@@ -202,6 +201,26 @@ command.
    This also goes for ``warewulf.conf`` as well - any changes made also require ``warewulfd`` to be restarted.
    The restart should be done using the following command: ``systemctl restart warewulfd``
 
+Upgrades
+========
+
+New versions of Warewulf might introduce changes to ``warewulf.conf`` and ``nodes.conf``.
+The ``wwctl upgrade`` command can help ease the transition between versions.
+
+.. note::
+
+   ``wwctl upgrade`` will back up any files before it changes them (to ``<name>-old``)
+   but it is good practice to back up your configuration manually.
+
+.. code-block:: console
+
+   # wwctl upgrade config
+   # wwctl upgrade nodes --add-defaults --replace-overlays
+
+Both upgrade commands support specifying ``--output-path=-``
+to print the upgraded configuration file to standard out
+for inspection before replacing the configuration files.
+
 Directories
 ===========
 

static/docs/main/_sources/contributing/development-environment-vagrant.rst.txt

@@ -190,7 +190,6 @@ Vagrantfile
 
             head.vm.provision "shell", inline: <<-SHELL
                 cat << 'CONF' | sudo tee /etc/warewulf/warewulf.conf
-    WW_INTERNAL: 45
     ipaddr: 192.168.200.254
     netmask: 255.255.255.0
     network: 192.168.200.0

static/docs/main/_sources/quickstart/debian12.rst.txt

@@ -65,7 +65,6 @@ address of your cluster's private network interface:
 
 .. code-block:: yaml
 
-	WW_INTERNAL: 45
 	ipaddr: 192.168.200.1
 	netmask: 255.255.255.0
 	network: 192.168.200.0

static/docs/main/_sources/quickstart/el.rst.txt

@@ -58,7 +58,6 @@ address of your cluster's private network interface.
 
 .. code-block:: yaml
 
-   WW_INTERNAL: 45
    ipaddr: 10.0.0.1
    netmask: 255.255.252.0
    network: 10.0.0.0

static/docs/main/_sources/quickstart/suse15.rst.txt

@@ -46,7 +46,6 @@ address of your cluster's private network interface:
 
 .. code-block:: yaml
 
-    WW_INTERNAL: 45
     ipaddr: 192.168.200.1
     netmask: 255.255.255.0
     network: 192.168.200.0

static/docs/main/contents/configuration.html

@@ -59,6 +59,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#nodes-conf">nodes.conf</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#upgrades">Upgrades</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#directories">Directories</a></li>
 </ul>
 </li>
@@ -128,8 +129,7 @@ <h1>Warewulf Configuration<a class="headerlink" href="#warewulf-configuration" t
 <h2>warewulf.conf<a class="headerlink" href="#warewulf-conf" title="Link to this heading"></a></h2>
 <p>The Warewulf configuration exists as follows in the current version of
 Warewulf (4.5.2):</p>
-<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">WW_INTERNAL</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">45</span>
-<span class="nt">ipaddr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10.0.0.1</span>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">ipaddr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10.0.0.1</span>
 <span class="nt">netmask</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">255.255.252.0</span>
 <span class="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10.0.0.0</span>
 <span class="nt">warewulf</span><span class="p">:</span>
@@ -293,6 +293,23 @@ <h2>nodes.conf<a class="headerlink" href="#nodes-conf" title="Link to this headi
 The restart should be done using the following command: <code class="docutils literal notranslate"><span class="pre">systemctl</span> <span class="pre">restart</span> <span class="pre">warewulfd</span></code></p>
 </div>
 </section>
+<section id="upgrades">
+<h2>Upgrades<a class="headerlink" href="#upgrades" title="Link to this heading"></a></h2>
+<p>New versions of Warewulf might introduce changes to <code class="docutils literal notranslate"><span class="pre">warewulf.conf</span></code> and <code class="docutils literal notranslate"><span class="pre">nodes.conf</span></code>.
+The <code class="docutils literal notranslate"><span class="pre">wwctl</span> <span class="pre">upgrade</span></code> command can help ease the transition between versions.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p><code class="docutils literal notranslate"><span class="pre">wwctl</span> <span class="pre">upgrade</span></code> will back up any files before it changes them (to <code class="docutils literal notranslate"><span class="pre">&lt;name&gt;-old</span></code>)
+but it is good practice to back up your configuration manually.</p>
+</div>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>wwctl<span class="w"> </span>upgrade<span class="w"> </span>config
+<span class="gp"># </span>wwctl<span class="w"> </span>upgrade<span class="w"> </span>nodes<span class="w"> </span>--add-defaults<span class="w"> </span>--replace-overlays
+</pre></div>
+</div>
+<p>Both upgrade commands support specifying <code class="docutils literal notranslate"><span class="pre">--output-path=-</span></code>
+to print the upgraded configuration file to standard out
+for inspection before replacing the configuration files.</p>
+</section>
 <section id="directories">
 <h2>Directories<a class="headerlink" href="#directories" title="Link to this heading"></a></h2>
 <p>The <code class="docutils literal notranslate"><span class="pre">/etc/warewulf/ipxe/</span></code> directory contains <em>text/templates</em> that

static/docs/main/contributing/development-environment-vagrant.html

@@ -301,7 +301,6 @@ <h3>Vagrantfile<a class="headerlink" href="#vagrantfile" title="Link to this hea
 
 <span class="s">        head.vm.provision &quot;shell&quot;, inline: &lt;&lt;-SHELL</span>
 <span class="s">            cat &lt;&lt; &#39;CONF&#39; | sudo tee /etc/warewulf/warewulf.conf</span>
-<span class="s">WW_INTERNAL: 45</span>
 <span class="s">ipaddr: 192.168.200.254</span>
 <span class="s">netmask: 255.255.255.0</span>
 <span class="s">network: 192.168.200.0</span>

static/docs/main/index.html

@@ -143,6 +143,7 @@ <h1>User Guide<a class="headerlink" href="#user-guide" title="Link to this headi
 <li class="toctree-l1"><a class="reference internal" href="contents/configuration.html">Warewulf Configuration</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="contents/configuration.html#warewulf-conf">warewulf.conf</a></li>
 <li class="toctree-l2"><a class="reference internal" href="contents/configuration.html#nodes-conf">nodes.conf</a></li>
+<li class="toctree-l2"><a class="reference internal" href="contents/configuration.html#upgrades">Upgrades</a></li>
 <li class="toctree-l2"><a class="reference internal" href="contents/configuration.html#directories">Directories</a></li>
 </ul>
 </li>

static/docs/main/quickstart/debian12.html

@@ -171,8 +171,7 @@ <h2>Configure the controller<a class="headerlink" href="#configure-the-controlle
 set the appropriate configuration parameters. Here are some of the
 defaults for reference assuming that <code class="docutils literal notranslate"><span class="pre">192.168.200.1</span></code> is the IP
 address of your cluster’s private network interface:</p>
-<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">WW_INTERNAL</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">45</span>
-<span class="nt">ipaddr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.200.1</span>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">ipaddr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.200.1</span>
 <span class="nt">netmask</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">255.255.255.0</span>
 <span class="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.200.0</span>
 <span class="nt">warewulf</span><span class="p">:</span>

static/docs/main/quickstart/el.html

@@ -170,8 +170,7 @@ <h2>Configure Warewulf<a class="headerlink" href="#configure-warewulf" title="Li
 set the appropriate configuration parameters. Here are some of the
 defaults for reference assuming that <code class="docutils literal notranslate"><span class="pre">10.0.0.1/22</span></code> is the IP
 address of your cluster’s private network interface.</p>
-<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">WW_INTERNAL</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">45</span>
-<span class="nt">ipaddr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10.0.0.1</span>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">ipaddr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10.0.0.1</span>
 <span class="nt">netmask</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">255.255.252.0</span>
 <span class="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10.0.0.0</span>
 <span class="nt">warewulf</span><span class="p">:</span>

static/docs/main/quickstart/suse15.html

@@ -158,8 +158,7 @@ <h2>Configure the controller<a class="headerlink" href="#configure-the-controlle
 set the appropriate configuration paramaters. Here are some of the
 defaults for reference assuming that <code class="docutils literal notranslate"><span class="pre">192.168.200.1</span></code> is the IP
 address of your cluster’s private network interface:</p>
-<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">WW_INTERNAL</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">45</span>
-<span class="nt">ipaddr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.200.1</span>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">ipaddr</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.200.1</span>
 <span class="nt">netmask</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">255.255.255.0</span>
 <span class="nt">network</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.200.0</span>
 <span class="nt">warewulf</span><span class="p">:</span>