Update main docs

Author: actions-user

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

@@ -443,19 +443,11 @@ Then, ``wwctl image exec`` will work regardless of the architecture of the
 image. For more information about QEMU, see their `GitHub
 <https://github.com/multiarch/qemu-user-static>`_
 
-To use wwclient on a booted image using a different architecture, wwclient must
-be compiled for the specific architecture. This requires GOLang build tools 1.21
-or newer. Below is an example for building wwclient for arm64:
-
-.. code-block:: console
-
-   # git clone https://github.com/warewulf/warewulf
-   # cd warewulf
-   # GOARCH=arm64 PREFIX=/ make wwclient
-   # mkdir -p /var/lib/warewulf/overlays/wwclient_arm64/rootfs/warewulf
-   # cp wwclient /var/lib/warewulf/overlays/wwclient_arm64/rootfs/warewulf
+.. note::
 
-Then, apply the new "wwclient_arm64" system overlay to your arm64 node/profile
+   When provisioning cluster nodes with a different architecture than the
+   Warewulf server, also use the matching architecture-specific :ref:`wwclient`
+   overlay: e.g., wwclient.x86_64 or wwclient.aarch64.
 
 Read-only images
 ================

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

@@ -202,16 +202,23 @@ provisioning actions:
 - **/warewulf/init.d/:** executed in the final root file system but before
   calling ``init``.
 
+.. _wwclient:
+
 wwclient
 --------
 
 All configured overlays are provisioned initially along with the node image
 itself; but **wwclient** periodically fetches and applies the runtime overlay to
 allow configuration of some settings without a reboot.
 
-wwclient will contat the ``ipaddr`` value from ``warewulf.conf`` by default.
-This can be overridden by specifying a ``WW_IPADDR`` environment variable, which
-can be set via an overlay in ``/etc/default/wwclient``.
+wwclient contacts the ``ipaddr`` value from ``warewulf.conf`` by default. This
+can be overridden by specifying a ``WW_IPADDR`` environment variable, which can
+be set via an overlay in ``/etc/default/wwclient``.
+
+The default wwclient overlay contains a ``wwclient`` executable compiled for the
+same architecture as the Warewulf server. Architecture-specific wwclient.aarch64
+and wwclient.x86_64 overlays are available as well. This supports using wwclient
+on cluster nodes with a different architecture than the Warewulf server.
 
 Network interfaces
 ------------------

static/docs/main/images/images.html

@@ -595,17 +595,12 @@ <h2>Image Architecture<a class="headerlink" href="#image-architecture" title="Li
 </div>
 <p>Then, <code class="docutils literal notranslate"><span class="pre">wwctl</span> <span class="pre">image</span> <span class="pre">exec</span></code> will work regardless of the architecture of the
 image. For more information about QEMU, see their <a class="reference external" href="https://github.com/multiarch/qemu-user-static">GitHub</a></p>
-<p>To use wwclient on a booted image using a different architecture, wwclient must
-be compiled for the specific architecture. This requires GOLang build tools 1.21
-or newer. Below is an example for building wwclient for arm64:</p>
-<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/warewulf/warewulf
-<span class="gp"># </span><span class="nb">cd</span><span class="w"> </span>warewulf
-<span class="gp"># </span><span class="nv">GOARCH</span><span class="o">=</span>arm64<span class="w"> </span><span class="nv">PREFIX</span><span class="o">=</span>/<span class="w"> </span>make<span class="w"> </span>wwclient
-<span class="gp"># </span>mkdir<span class="w"> </span>-p<span class="w"> </span>/var/lib/warewulf/overlays/wwclient_arm64/rootfs/warewulf
-<span class="gp"># </span>cp<span class="w"> </span>wwclient<span class="w"> </span>/var/lib/warewulf/overlays/wwclient_arm64/rootfs/warewulf
-</pre></div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>When provisioning cluster nodes with a different architecture than the
+Warewulf server, also use the matching architecture-specific <a class="reference internal" href="../overlays/overlays.html#wwclient"><span class="std std-ref">wwclient</span></a>
+overlay: e.g., wwclient.x86_64 or wwclient.aarch64.</p>
 </div>
-<p>Then, apply the new “wwclient_arm64” system overlay to your arm64 node/profile</p>
 </section>
 <section id="read-only-images">
 <h2>Read-only images<a class="headerlink" href="#read-only-images" title="Link to this heading"></a></h2>

static/docs/main/objects.inv

@@ -399,13 +399,17 @@ <h3>wwinit<a class="headerlink" href="#wwinit" title="Link to this heading"><
 </ul>
 </section>
 <section id="wwclient">
-<h3>wwclient<a class="headerlink" href="#wwclient" title="Link to this heading"></a></h3>
+<span id="id1"></span><h3>wwclient<a class="headerlink" href="#wwclient" title="Link to this heading"></a></h3>
 <p>All configured overlays are provisioned initially along with the node image
 itself; but <strong>wwclient</strong> periodically fetches and applies the runtime overlay to
 allow configuration of some settings without a reboot.</p>
-<p>wwclient will contat the <code class="docutils literal notranslate"><span class="pre">ipaddr</span></code> value from <code class="docutils literal notranslate"><span class="pre">warewulf.conf</span></code> by default.
-This can be overridden by specifying a <code class="docutils literal notranslate"><span class="pre">WW_IPADDR</span></code> environment variable, which
-can be set via an overlay in <code class="docutils literal notranslate"><span class="pre">/etc/default/wwclient</span></code>.</p>
+<p>wwclient contacts the <code class="docutils literal notranslate"><span class="pre">ipaddr</span></code> value from <code class="docutils literal notranslate"><span class="pre">warewulf.conf</span></code> by default. This
+can be overridden by specifying a <code class="docutils literal notranslate"><span class="pre">WW_IPADDR</span></code> environment variable, which can
+be set via an overlay in <code class="docutils literal notranslate"><span class="pre">/etc/default/wwclient</span></code>.</p>
+<p>The default wwclient overlay contains a <code class="docutils literal notranslate"><span class="pre">wwclient</span></code> executable compiled for the
+same architecture as the Warewulf server. Architecture-specific wwclient.aarch64
+and wwclient.x86_64 overlays are available as well. This supports using wwclient
+on cluster nodes with a different architecture than the Warewulf server.</p>
 </section>
 <section id="network-interfaces">
 <h3>Network interfaces<a class="headerlink" href="#network-interfaces" title="Link to this heading"></a></h3>
@@ -489,7 +493,7 @@ <h3>ssh<a class="headerlink" href="#ssh" title="Link to this heading"></a></h
 </ul>
 </section>
 <section id="syncuser">
-<span id="id1"></span><h3>syncuser<a class="headerlink" href="#syncuser" title="Link to this heading"></a></h3>
+<span id="id2"></span><h3>syncuser<a class="headerlink" href="#syncuser" title="Link to this heading"></a></h3>
 <p>The <strong>syncuser</strong> overlay updates <code class="docutils literal notranslate"><span class="pre">/etc/passwd</span></code> and <code class="docutils literal notranslate"><span class="pre">/etc/group</span></code> to include
 all users on both the Warewulf server and from the image.</p>
 <p>To function properly, <code class="docutils literal notranslate"><span class="pre">wwctl</span> <span class="pre">image</span> <span class="pre">syncuser</span></code> (or the <code class="docutils literal notranslate"><span class="pre">--syncuser</span></code> option
@@ -544,7 +548,7 @@ <h3>debug<a class="headerlink" href="#debug" title="Link to this heading"></a
 </div>
 </section>
 <section id="localtime">
-<span id="id2"></span><h3>localtime<a class="headerlink" href="#localtime" title="Link to this heading"></a></h3>
+<span id="id3"></span><h3>localtime<a class="headerlink" href="#localtime" title="Link to this heading"></a></h3>
 <p>The <strong>localtime</strong> overlay configures the timezone of a cluster node to match
 that of the Warewulf server; alternatively, a different timezone may be
 specified with a <code class="docutils literal notranslate"><span class="pre">localtime</span></code> tag.</p>