Documentation for wwctl upgrade

Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
Jonathon Anderson
2024-11-05 16:05:28 -07:00
parent b37d49d6de
commit 2bae87e244
2 changed files with 21 additions and 0 deletions

View File

@@ -201,6 +201,26 @@ command.
This also goes for ``warewulf.conf`` as well - any changes made also require ``warewulfd`` to be restarted.
The restart should be done using the following command: ``systemctl restart warewulfd``
Upgrades
========
New versions of Warewulf might introduce changes to ``warewulf.conf`` and ``nodes.conf``.
The ``wwctl upgrade`` command can help ease the transition between versions.
.. note::
``wwctl upgrade`` will back up any files before it changes them (to ``<name>-old``)
but it is good practice to back up your configuration manually.
.. code-block:: console
# wwctl upgrade config
# wwctl upgrade nodes --add-defaults --replace-overlays
Both upgrade commands support specifying ``--output-path=-``
to print the upgraded configuration file to standard out
for inspection before replacing the configuration files.
Directories
===========