Skip to content

Commit 6b710bc

Browse files
committed
Update main docs
1 parent a0ae496 commit 6b710bc

File tree

5 files changed

+20
-89
lines changed

5 files changed

+20
-89
lines changed

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

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -203,47 +203,14 @@ Resources can only be managed with ``wwctl node edit``.
203203
Importing Nodes From a File
204204
===========================
205205

206-
You can import nodes into Warewulf by using the ``wwctl node import`` command. The
207-
file used must be in YAML or CSV format.
208-
209-
.. warning::
210-
Importing a node configuration will fully overwrite the existing settings,
211-
including any customizations not present in the import file. If the node
212-
already exists and you wish to update it, ensure that the import file
213-
includes all the options you want to retain.
214-
215-
CSV Import
216-
----------
217-
218-
.. note::
219-
As of Warewulf v4.6.1, the csv import functionality is broken and an
220-
`issue <https://github.com/warewulf/warewulf/issues/1862>`_
221-
has been created to track this.
222-
223-
The CSV file must have a header where the first field must always be the nodename,
224-
and the rest of the fields are the same as the long commandline options. Network
225-
device must have the form ``net.$NETNAME.$NETOPTION``. (e.g., ``net.default.ipaddr``).
226-
Tags are currently not supported and must be added separately after the import.
227-
228-
As an example, the following CSV file:
229-
230-
.. code-block:: csv
231-
232-
nodename,net.default.hwaddr,net.default.ipaddr,net.default.netmask,net.default.gateway,discoverable,image
233-
n1,00:00:00:00:00:01,10.0.2.1,255.255.255.0,10.0.2.254,false,rockylinux-9
234-
235-
This can be imported with the following command:
236-
237-
.. code-block:: shell
238-
239-
wwctl node import --csv /path/to/nodes.csv
240-
241-
YAML Import
242-
-----------
243-
244-
The YAML file must be a mapping of node names to their attributes, where each node is represented as a dictionary of attributes.
245-
To simplify the creation of the YAML file, you can use the wwctl node export command to export the current node configuration to a YAML file.
246-
This exported file can serve as a template for creating new nodes.
206+
You can import nodes into Warewulf by using the ``wwctl node import`` command.
207+
The file used must be in YAML format.
208+
209+
The YAML file must be a mapping of node names to their attributes, where each
210+
node is represented as a dictionary of attributes. To simplify the creation of
211+
the YAML file, you can use the wwctl node export command to export the current
212+
node configuration to a YAML file. This exported file can serve as a template
213+
for creating new nodes.
247214

248215
A minimal example of a YAML file looks like this:
249216

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Synopsis
99
~~~~~~~~
1010

1111

12-
This command imports all the nodes defined in a file. It will overwrite nodes with same name.
12+
This command imports all the nodes defined in a YAML file. It will overwrite nodes with same name.
1313

1414
::
1515

@@ -20,7 +20,6 @@ Options
2020

2121
::
2222

23-
-c, --csv Import CSV file
2423
-h, --help help for import
2524
-y, --yes Set 'yes' to all questions asked
2625

static/docs/main/nodes/nodes.html

Lines changed: 8 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,7 @@
8181
<li class="toctree-l2"><a class="reference internal" href="#node-discovery">Node Discovery</a></li>
8282
<li class="toctree-l2"><a class="reference internal" href="#tags">Tags</a></li>
8383
<li class="toctree-l2"><a class="reference internal" href="#resources">Resources</a></li>
84-
<li class="toctree-l2"><a class="reference internal" href="#importing-nodes-from-a-file">Importing Nodes From a File</a><ul>
85-
<li class="toctree-l3"><a class="reference internal" href="#csv-import">CSV Import</a></li>
86-
<li class="toctree-l3"><a class="reference internal" href="#yaml-import">YAML Import</a></li>
87-
</ul>
88-
</li>
84+
<li class="toctree-l2"><a class="reference internal" href="#importing-nodes-from-a-file">Importing Nodes From a File</a></li>
8985
</ul>
9086
</li>
9187
<li class="toctree-l1"><a class="reference internal" href="profiles.html">Node Profiles</a></li>
@@ -385,42 +381,13 @@ <h2>Resources<a class="headerlink" href="#resources" title="Link to this heading
385381
</section>
386382
<section id="importing-nodes-from-a-file">
387383
<h2>Importing Nodes From a File<a class="headerlink" href="#importing-nodes-from-a-file" title="Link to this heading"></a></h2>
388-
<p>You can import nodes into Warewulf by using the <code class="docutils literal notranslate"><span class="pre">wwctl</span> <span class="pre">node</span> <span class="pre">import</span></code> command. The
389-
file used must be in YAML or CSV format.</p>
390-
<div class="admonition warning">
391-
<p class="admonition-title">Warning</p>
392-
<p>Importing a node configuration will fully overwrite the existing settings,
393-
including any customizations not present in the import file. If the node
394-
already exists and you wish to update it, ensure that the import file
395-
includes all the options you want to retain.</p>
396-
</div>
397-
<section id="csv-import">
398-
<h3>CSV Import<a class="headerlink" href="#csv-import" title="Link to this heading"></a></h3>
399-
<div class="admonition note">
400-
<p class="admonition-title">Note</p>
401-
<p>As of Warewulf v4.6.1, the csv import functionality is broken and an
402-
<a class="reference external" href="https://github.com/warewulf/warewulf/issues/1862">issue</a>
403-
has been created to track this.</p>
404-
</div>
405-
<p>The CSV file must have a header where the first field must always be the nodename,
406-
and the rest of the fields are the same as the long commandline options. Network
407-
device must have the form <code class="docutils literal notranslate"><span class="pre">net.$NETNAME.$NETOPTION</span></code>. (e.g., <code class="docutils literal notranslate"><span class="pre">net.default.ipaddr</span></code>).
408-
Tags are currently not supported and must be added separately after the import.</p>
409-
<p>As an example, the following CSV file:</p>
410-
<div class="highlight-csv notranslate"><div class="highlight"><pre><span></span>nodename,net.default.hwaddr,net.default.ipaddr,net.default.netmask,net.default.gateway,discoverable,image
411-
n1,00:00:00:00:00:01,10.0.2.1,255.255.255.0,10.0.2.254,false,rockylinux-9
412-
</pre></div>
413-
</div>
414-
<p>This can be imported with the following command:</p>
415-
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>wwctl<span class="w"> </span>node<span class="w"> </span>import<span class="w"> </span>--csv<span class="w"> </span>/path/to/nodes.csv
416-
</pre></div>
417-
</div>
418-
</section>
419-
<section id="yaml-import">
420-
<h3>YAML Import<a class="headerlink" href="#yaml-import" title="Link to this heading"></a></h3>
421-
<p>The YAML file must be a mapping of node names to their attributes, where each node is represented as a dictionary of attributes.
422-
To simplify the creation of the YAML file, you can use the wwctl node export command to export the current node configuration to a YAML file.
423-
This exported file can serve as a template for creating new nodes.</p>
384+
<p>You can import nodes into Warewulf by using the <code class="docutils literal notranslate"><span class="pre">wwctl</span> <span class="pre">node</span> <span class="pre">import</span></code> command.
385+
The file used must be in YAML format.</p>
386+
<p>The YAML file must be a mapping of node names to their attributes, where each
387+
node is represented as a dictionary of attributes. To simplify the creation of
388+
the YAML file, you can use the wwctl node export command to export the current
389+
node configuration to a YAML file. This exported file can serve as a template
390+
for creating new nodes.</p>
424391
<p>A minimal example of a YAML file looks like this:</p>
425392
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">n1</span><span class="p">:</span>
426393
<span class="w"> </span><span class="nt">profiles</span><span class="p">:</span>
@@ -451,7 +418,6 @@ <h3>YAML Import<a class="headerlink" href="#yaml-import" title="Link to this hea
451418
</pre></div>
452419
</div>
453420
</section>
454-
</section>
455421
</section>
456422

457423

static/docs/main/reference/wwctl_node_import.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,15 +208,14 @@
208208
<p>Import node(s) from yaml FILE</p>
209209
<section id="synopsis">
210210
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
211-
<p>This command imports all the nodes defined in a file. It will overwrite nodes with same name.</p>
211+
<p>This command imports all the nodes defined in a YAML file. It will overwrite nodes with same name.</p>
212212
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">wwctl</span> <span class="n">node</span> <span class="kn">import</span><span class="w"> </span><span class="p">[</span><span class="n">OPTIONS</span><span class="p">]</span> <span class="n">FILE</span>
213213
</pre></div>
214214
</div>
215215
</section>
216216
<section id="options">
217217
<h2>Options<a class="headerlink" href="#options" title="Link to this heading"></a></h2>
218-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-</span><span class="n">c</span><span class="p">,</span> <span class="o">--</span><span class="n">csv</span> <span class="n">Import</span> <span class="n">CSV</span> <span class="n">file</span>
219-
<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="kn">import</span>
218+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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="kn">import</span>
220219
<span class="o">-</span><span class="n">y</span><span class="p">,</span> <span class="o">--</span><span class="n">yes</span> <span class="n">Set</span> <span class="s1">&#39;yes&#39;</span> <span class="n">to</span> <span class="nb">all</span> <span class="n">questions</span> <span class="n">asked</span>
221220
</pre></div>
222221
</div>

static/docs/main/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)