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 Oct 31, 2024
1 parent 32eb102 commit 94308a1
Show file tree
Hide file tree
Showing 11 changed files with 10 additions and 58 deletions.
3 changes: 1 addition & 2 deletions static/docs/main/_sources/contents/configuration.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,7 @@ explained as follows:
services.)

* ``warewulf:syslog``: This determines whether Warewulf server logs go
to syslog or are written directly to a log file. (e.g.,
``/var/log/warewulfd.log``)
to syslog.

* ``nfs:export paths``: Warewulf can automatically set up these NFS
exports.
Expand Down
19 changes: 0 additions & 19 deletions static/docs/main/_sources/contents/initialization.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,3 @@ systemd service:
.. code-block:: console
# systemctl enable --now warewulfd
You can also check and control the Warewulf service using the ``wwctl``
command line program as follows:

.. code-block:: console
# wwctl server status
.. note::

If the Warewulf service is running via systemd, restarting
stopping, and starting it from the ``wwctl`` command may result in
unexpected results.

Logs
----

The Warewulf server logs are by default written to
``/var/log/warewulfd.log``.
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,6 @@ Build and install Warewulf on wwdev
sudo wwctl overlay build -a
# Start the Warewulf daemon
sudo wwctl ready
sudo wwctl server start
sudo wwctl server status
sudo wwctl server &
Boot your node and watch the bash and the output of the Warewulfd process
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ Vagrantfile
systemd name: nfs-server
CONF
sed -i 's@ExecStart=/usr/bin/wwctl server start@ExecStart=/usr/bin/wwctl server start -d -v@' /usr/lib/systemd/system/warewulfd.service
sed -i 's@ExecStart=/usr/bin/wwctl server@ExecStart=/usr/bin/wwctl server -d -v@' /usr/lib/systemd/system/warewulfd.service
systemctl enable --now warewulfd
wwctl configure --all
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,7 @@ I have VirtualBox running on my desktop.
sudo wwctl overlay build -a
# Start the Warewulf daemon
sudo wwctl ready
sudo wwctl server start
sudo wwctl server status
sudo wwctl server &
4. Create a new guest VM instance inside the VirtualBox to be the
Warewulf client/compute node. Under the system configuration make
Expand Down
3 changes: 1 addition & 2 deletions static/docs/main/contents/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,7 @@ <h2>warewulf.conf<a class="headerlink" href="#warewulf-conf" title="Link to this
configuration. (The host overlay is used to configure the dependent
services.)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">warewulf:syslog</span></code>: This determines whether Warewulf server logs go
to syslog or are written directly to a log file. (e.g.,
<code class="docutils literal notranslate"><span class="pre">/var/log/warewulfd.log</span></code>)</p></li>
to syslog.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">nfs:export</span> <span class="pre">paths</span></code>: Warewulf can automatically set up these NFS
exports.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">container</span> <span class="pre">mounts</span></code>: These paths are mounted into the container
Expand Down
21 changes: 1 addition & 20 deletions static/docs/main/contents/initialization.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,7 @@
<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Warewulf Initialization</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#system-services">System Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="#warewulf-service">Warewulf Service</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#logs">Logs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#warewulf-service">Warewulf Service</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
Expand Down Expand Up @@ -160,22 +157,6 @@ <h2>Warewulf Service<a class="headerlink" href="#warewulf-service" title="Link t
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>systemctl<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>--now<span class="w"> </span>warewulfd
</pre></div>
</div>
<p>You can also check and control the Warewulf service using the <code class="docutils literal notranslate"><span class="pre">wwctl</span></code>
command line program as follows:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>wwctl<span class="w"> </span>server<span class="w"> </span>status
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If the Warewulf service is running via systemd, restarting
stopping, and starting it from the <code class="docutils literal notranslate"><span class="pre">wwctl</span></code> command may result in
unexpected results.</p>
</div>
<section id="logs">
<h3>Logs<a class="headerlink" href="#logs" title="Link to this heading"></a></h3>
<p>The Warewulf server logs are by default written to
<code class="docutils literal notranslate"><span class="pre">/var/log/warewulfd.log</span></code>.</p>
</section>
</section>
</section>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,9 +231,7 @@ <h2>Build and install Warewulf on wwdev<a class="headerlink" href="#build-and-in
sudo wwctl overlay build -a

# Start the Warewulf daemon
sudo wwctl ready
sudo wwctl server start
sudo wwctl server status
sudo wwctl server &amp;
</pre></div>
</div>
<p>Boot your node and watch the bash and the output of the Warewulfd process</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ <h3>Vagrantfile<a class="headerlink" href="#vagrantfile" title="Link to this hea
<span class="s"> systemd name: nfs-server</span>
<span class="s">CONF</span>

<span class="s"> sed -i &#39;s@ExecStart=/usr/bin/wwctl server start@ExecStart=/usr/bin/wwctl server start -d -v@&#39; /usr/lib/systemd/system/warewulfd.service</span>
<span class="s"> sed -i &#39;s@ExecStart=/usr/bin/wwctl server@ExecStart=/usr/bin/wwctl server -d -v@&#39; /usr/lib/systemd/system/warewulfd.service</span>
<span class="s"> systemctl enable --now warewulfd</span>

<span class="s"> wwctl configure --all</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -245,9 +245,7 @@ <h1>Development Environment (VirtualBox)<a class="headerlink" href="#development
sudo wwctl overlay build -a

# Start the Warewulf daemon
sudo wwctl ready
sudo wwctl server start
sudo wwctl server status
sudo wwctl server &amp;
</pre></div>
</div>
<ol class="arabic simple" start="4">
Expand Down
2 changes: 1 addition & 1 deletion static/docs/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 94308a1

Please sign in to comment.