Update development docs

warewulf · Jun 8, 2023 · b34c2c1 · b34c2c1
1 parent 627341e
commit b34c2c1
Show file tree

Hide file tree

Showing 34 changed files with 245 additions and 5 deletions.
diff --git a/static/docs/development/_sources/contents/wwctl.rst.txt b/static/docs/development/_sources/contents/wwctl.rst.txt
@@ -0,0 +1,33 @@
+============================
+Controlling Warewulf (wwctl)
+============================
+
+Warewulf's command-line interface is based primarily around the
+``wwctl`` command. This command has sub-commands for each major
+component of Warewulf's functionality.
+
+* ``configure`` configures external services that Warewulf depends on
+* ``container`` configures containers (node images)
+* ``kernel`` configures override kernels
+* ``node`` manages nodes in the cluster
+* ``profiles`` defines configuration which can be applied to multiple
+  nodes
+* ``overlays`` manages nodes
+* ``power`` turns nodes on and off
+* ``ssh`` provides basic parallel ssh functionality
+
+All of these subcommands (and their respective sub-subcommands) have
+built-in help with either ``wwctl help`` or ``--help``.
+
+Hostlists
+=========
+
+Many of the commands (e.g., ``wwctl node list`` support a "hostlist"
+syntax for referring to multiple nodes at once. Hostlist expressions
+support both ranges and comma-separated numerical lists.
+
+For example:
+
+* ``node[1-2]`` expands to ``node1 node2``
+* ``node[1,3]`` expands to ``node1 node3``
+* ``node[1,5-6]`` expands to ``node1 node5 node6``
diff --git a/static/docs/development/_sources/index.rst.txt b/static/docs/development/_sources/index.rst.txt
@@ -14,6 +14,7 @@ Welcome to the Warewulf User Guide!
    Control Server Setup <contents/setup>
    Warewulf Installation <contents/installation>
    Warewulf Configuration <contents/configuration>
+   Controlling Warewulf (wwctl) <contents/wwctl>
    Warewulf Initialization <contents/initialization>
    Container Management <contents/containers>
    Kernel Management <contents/kernel>

diff --git a/static/docs/development/contents/background.html b/static/docs/development/contents/background.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/configuration.html b/static/docs/development/contents/configuration.html
@@ -20,7 +20,7 @@
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Warewulf Initialization" href="initialization.html" />
+    <link rel="next" title="Controlling Warewulf (wwctl)" href="wwctl.html" />
     <link rel="prev" title="Warewulf Installation" href="installation.html" /> 
 </head>
 
@@ -58,6 +58,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#directories">Directories</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>
@@ -272,7 +273,7 @@ <h2>Directories<a class="headerlink" href="#directories" title="Permalink to thi
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="installation.html" class="btn btn-neutral float-left" title="Warewulf Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="initialization.html" class="btn btn-neutral float-right" title="Warewulf Initialization" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="wwctl.html" class="btn btn-neutral float-right" title="Controlling Warewulf (wwctl)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/static/docs/development/contents/containers.html b/static/docs/development/contents/containers.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Container Management</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#container-tools">Container Tools</a></li>

diff --git a/static/docs/development/contents/dnsmasq.html b/static/docs/development/contents/dnsmasq.html
@@ -50,6 +50,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/glossary.html b/static/docs/development/contents/glossary.html
@@ -51,6 +51,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/initialization.html b/static/docs/development/contents/initialization.html
@@ -21,7 +21,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Container Management" href="containers.html" />
-    <link rel="prev" title="Warewulf Configuration" href="configuration.html" /> 
+    <link rel="prev" title="Controlling Warewulf (wwctl)" href="wwctl.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<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>
@@ -176,7 +177,7 @@ <h3>Logs<a class="headerlink" href="#logs" title="Permalink to this heading">
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="configuration.html" class="btn btn-neutral float-left" title="Warewulf Configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="wwctl.html" class="btn btn-neutral float-left" title="Controlling Warewulf (wwctl)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="containers.html" class="btn btn-neutral float-right" title="Container Management" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

diff --git a/static/docs/development/contents/installation.html b/static/docs/development/contents/installation.html
@@ -65,6 +65,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/introduction.html b/static/docs/development/contents/introduction.html
@@ -57,6 +57,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/ipmi.html b/static/docs/development/contents/ipmi.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/kernel.html b/static/docs/development/contents/kernel.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Kernel Management</a><ul>

diff --git a/static/docs/development/contents/nodeconfig.html b/static/docs/development/contents/nodeconfig.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/overlays.html b/static/docs/development/contents/overlays.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/profiles.html b/static/docs/development/contents/profiles.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/provisioning.html b/static/docs/development/contents/provisioning.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/security.html b/static/docs/development/contents/security.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/setup.html b/static/docs/development/contents/setup.html
@@ -57,6 +57,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/stateless.html b/static/docs/development/contents/stateless.html
@@ -57,6 +57,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>

diff --git a/static/docs/development/contents/templating.html b/static/docs/development/contents/templating.html
@@ -52,6 +52,7 @@
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Control Server Setup</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Warewulf Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="configuration.html">Warewulf Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="wwctl.html">Controlling Warewulf (wwctl)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="initialization.html">Warewulf Initialization</a></li>
 <li class="toctree-l1"><a class="reference internal" href="containers.html">Container Management</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Management</a></li>