Skip to content

Commit 1c55dba

Browse files
committed
Update main docs
1 parent 0a72f38 commit 1c55dba

File tree

4 files changed

+14
-10
lines changed

4 files changed

+14
-10
lines changed

static/docs/main/_sources/getting-started/debian-quickstart.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ and set it for the "default" node profile.
127127

128128
.. code-block:: bash
129129
130-
sudo wwctl image import docker://ghcr.io/warewulf/warewulf-debian:12.0 debian-12.0
130+
sudo wwctl image import --build docker://ghcr.io/warewulf/warewulf-debian:12.0 debian-12.0
131131
sudo wwctl profile set default --image=debian-12.0
132132
133133
Set up the default node profile
@@ -179,7 +179,7 @@ configurations.
179179

180180
.. code-block:: bash
181181
182-
sudo wwctl node add n0000.cluster --ipaddr 192.168.200.100 --discoverable true
182+
sudo wwctl node add n0000.cluster --ipaddr 192.168.200.100 --discoverable
183183
184184
At this point you can view the basic configuration of this node by
185185
typing the following:

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@ Options
2222
::
2323

2424
-b, --bind stringArray source[:destination[:{ro|copy}]]
25-
Bind a local path which must exist into the image. If destination is not
26-
set, uses the same path as source. "ro" binds read-only. "copy" temporarily
25+
Bind a local path which must exist into the image.
26+
If destination is not set, uses the same path as
27+
source. "ro" binds read-only. "copy" temporarily
2728
copies the file into the image.
2829
--build (Re)build the image automatically (default true)
2930
-h, --help help for shell
30-
-n, --node string Create a read only view of the image for the given node
31+
-n, --node string Create a read only view of the image for the given
32+
node
3133
--syncuser Synchronize UIDs/GIDs from host to image
3234

3335
Options inherited from parent commands

static/docs/main/getting-started/debian-quickstart.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ <h2>Configure system services automatically<a class="headerlink" href="#configur
321321
<h2>Pull and build the image<a class="headerlink" href="#pull-and-build-the-image" title="Link to this heading"></a></h2>
322322
<p>This will pull a basic image from Docker Hub
323323
and set it for the “default” node profile.</p>
324-
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>wwctl<span class="w"> </span>image<span class="w"> </span>import<span class="w"> </span>docker://ghcr.io/warewulf/warewulf-debian:12.0<span class="w"> </span>debian-12.0
324+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>wwctl<span class="w"> </span>image<span class="w"> </span>import<span class="w"> </span>--build<span class="w"> </span>docker://ghcr.io/warewulf/warewulf-debian:12.0<span class="w"> </span>debian-12.0
325325
sudo<span class="w"> </span>wwctl<span class="w"> </span>profile<span class="w"> </span><span class="nb">set</span><span class="w"> </span>default<span class="w"> </span>--image<span class="o">=</span>debian-12.0
326326
</pre></div>
327327
</div>
@@ -361,7 +361,7 @@ <h2>Add a node<a class="headerlink" href="#add-a-node" title="Link to this headi
361361
<p>Note that the full node configuration comes from both cascading
362362
profiles and node configurations which always supersede profile
363363
configurations.</p>
364-
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>wwctl<span class="w"> </span>node<span class="w"> </span>add<span class="w"> </span>n0000.cluster<span class="w"> </span>--ipaddr<span class="w"> </span><span class="m">192</span>.168.200.100<span class="w"> </span>--discoverable<span class="w"> </span><span class="nb">true</span>
364+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>wwctl<span class="w"> </span>node<span class="w"> </span>add<span class="w"> </span>n0000.cluster<span class="w"> </span>--ipaddr<span class="w"> </span><span class="m">192</span>.168.200.100<span class="w"> </span>--discoverable
365365
</pre></div>
366366
</div>
367367
<p>At this point you can view the basic configuration of this node by

static/docs/main/reference/wwctl_image_shell.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -216,12 +216,14 @@ <h2>Synopsis<a class="headerlink" href="#synopsis" title="Link to this heading">
216216
<section id="options">
217217
<h2>Options<a class="headerlink" href="#options" title="Link to this heading"></a></h2>
218218
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span><span class="n">b</span><span class="p">,</span> <span class="o">--</span><span class="n">bind</span> <span class="n">stringArray</span> <span class="n">source</span><span class="p">[:</span><span class="n">destination</span><span class="p">[:{</span><span class="n">ro</span><span class="o">|</span><span class="n">copy</span><span class="p">}]]</span>
219-
<span class="n">Bind</span> <span class="n">a</span> <span class="n">local</span> <span class="n">path</span> <span class="n">which</span> <span class="n">must</span> <span class="n">exist</span> <span class="n">into</span> <span class="n">the</span> <span class="n">image</span><span class="o">.</span> <span class="n">If</span> <span class="n">destination</span> <span class="ow">is</span> <span class="ow">not</span>
220-
<span class="nb">set</span><span class="p">,</span> <span class="n">uses</span> <span class="n">the</span> <span class="n">same</span> <span class="n">path</span> <span class="k">as</span> <span class="n">source</span><span class="o">.</span> <span class="s2">&quot;ro&quot;</span> <span class="n">binds</span> <span class="n">read</span><span class="o">-</span><span class="n">only</span><span class="o">.</span> <span class="s2">&quot;copy&quot;</span> <span class="n">temporarily</span>
219+
<span class="n">Bind</span> <span class="n">a</span> <span class="n">local</span> <span class="n">path</span> <span class="n">which</span> <span class="n">must</span> <span class="n">exist</span> <span class="n">into</span> <span class="n">the</span> <span class="n">image</span><span class="o">.</span>
220+
<span class="n">If</span> <span class="n">destination</span> <span class="ow">is</span> <span class="ow">not</span> <span class="nb">set</span><span class="p">,</span> <span class="n">uses</span> <span class="n">the</span> <span class="n">same</span> <span class="n">path</span> <span class="k">as</span>
221+
<span class="n">source</span><span class="o">.</span> <span class="s2">&quot;ro&quot;</span> <span class="n">binds</span> <span class="n">read</span><span class="o">-</span><span class="n">only</span><span class="o">.</span> <span class="s2">&quot;copy&quot;</span> <span class="n">temporarily</span>
221222
<span class="n">copies</span> <span class="n">the</span> <span class="n">file</span> <span class="n">into</span> <span class="n">the</span> <span class="n">image</span><span class="o">.</span>
222223
<span class="o">--</span><span class="n">build</span> <span class="p">(</span><span class="n">Re</span><span class="p">)</span><span class="n">build</span> <span class="n">the</span> <span class="n">image</span> <span class="n">automatically</span> <span class="p">(</span><span class="n">default</span> <span class="n">true</span><span class="p">)</span>
223224
<span class="o">-</span><span class="n">h</span><span class="p">,</span> <span class="o">--</span><span class="n">help</span> <span class="n">help</span> <span class="k">for</span> <span class="n">shell</span>
224-
<span class="o">-</span><span class="n">n</span><span class="p">,</span> <span class="o">--</span><span class="n">node</span> <span class="n">string</span> <span class="n">Create</span> <span class="n">a</span> <span class="n">read</span> <span class="n">only</span> <span class="n">view</span> <span class="n">of</span> <span class="n">the</span> <span class="n">image</span> <span class="k">for</span> <span class="n">the</span> <span class="n">given</span> <span class="n">node</span>
225+
<span class="o">-</span><span class="n">n</span><span class="p">,</span> <span class="o">--</span><span class="n">node</span> <span class="n">string</span> <span class="n">Create</span> <span class="n">a</span> <span class="n">read</span> <span class="n">only</span> <span class="n">view</span> <span class="n">of</span> <span class="n">the</span> <span class="n">image</span> <span class="k">for</span> <span class="n">the</span> <span class="n">given</span>
226+
<span class="n">node</span>
225227
<span class="o">--</span><span class="n">syncuser</span> <span class="n">Synchronize</span> <span class="n">UIDs</span><span class="o">/</span><span class="n">GIDs</span> <span class="kn">from</span><span class="w"> </span><span class="nn">host</span> <span class="n">to</span> <span class="n">image</span>
226228
</pre></div>
227229
</div>

0 commit comments

Comments
 (0)