Skip to content

Document qvm-template-upgrade in tools reference and template upgrade pages #1737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nihalxkumar wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document qvm-template-upgrade in tools reference and template upgrade pages #1737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7eeecb9
Add qvm-template-upgrade to the tools reference
nihalxkumar Jul 21, 2026
01b966b
Add guide for automated upgrade with qvm-template-upgrade
nihalxkumar Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions user/reference/tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Dom0
- :doc:`core-admin <core-admin:manpages/index>`
- :doc:`core-admin-client <core-admin-client:manpages/index>`
- `qvm-appmenus <https://github.com/QubesOS/qubes-desktop-linux-common/blob/master/doc/tools/qvm-appmenus.rst>`__
- `qvm-template-upgrade <https://github.com/QubesOS/qubes-core-admin-linux/blob/main/doc/tools/qvm-template-upgrade.rst>`__
- `qvm-xkill <https://github.com/QubesOS/qubes-desktop-linux-common/blob/master/doc/tools/qvm-xkill.rst>`__

DomU
Expand Down
14 changes: 14 additions & 0 deletions user/templates/debian/debian-upgrade.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,20 @@ This page provides instructions for performing an in-place upgrade of an install

By default, Qubes uses code `names` in the apt sources files (bookworm, trixie, etc), although the templates are referred to by release number. Check the code names for the templates, and ensure you are aware of any changes you have made in the repository definitions.

Automated upgrade with qvm-template-upgrade
-------------------------------------------


The `qvm-template-upgrade <https://github.com/QubesOS/qubes-core-admin-linux/blob/main/doc/tools/qvm-template-upgrade.rst>`__ tool automates the clone-and-upgrade procedure described on this page: it clones the template, upgrades the clone to the next Debian release (including updating the ``apt`` sources to the new release's code name), and sets the ``template-name`` feature used by the Qubes updater.

.. code:: console

[user@dom0 ~]$ qvm-template-upgrade --template=debian-<old>

By default, the clone is named by replacing the release number in the source name, e.g. ``debian-12`` becomes ``debian-13`` and ``debian-12-minimal`` becomes ``debian-13-minimal``. Use ``--new-name=<NAME>`` to choose a different name, and ``--dry-run`` to preview the planned upgrade without creating a clone.

After the upgrade completes, remember to :ref:`switch everything that was set to the old template to the new template <user/templates/templates:switching>` and, optionally, make the new template the global default and uninstall the old template, as described in the manual instructions below. Use the manual instructions if you need finer control over the upgrade process or if the automated upgrade fails.

Summary instructions for Debian templates
-----------------------------------------

Expand Down
14 changes: 14 additions & 0 deletions user/templates/fedora/fedora-upgrade.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ This page provides instructions for performing an in-place upgrade of an install
.. note::
In what follows the prompt on each line indicates where each command should be entered: ``dom0``, ``fedora-<old>``, or ``fedora-<new>``, where ``<old>`` is the fedora version number *from* which you are upgrading, and ``<new>`` is the fedora version number *to* which you are upgrading. Remember to use the right template *version*: eg clone ``fedora-<old>-minimal`` to ``fedora-<new>-minimal``.

Automated upgrade with qvm-template-upgrade
-------------------------------------------


The `qvm-template-upgrade <https://github.com/QubesOS/qubes-core-admin-linux/blob/main/doc/tools/qvm-template-upgrade.rst>`__ tool automates the clone-and-upgrade procedure described on this page: it clones the template, upgrades the clone to the next Fedora release, and sets the ``template-name`` feature used by the Qubes updater.

.. code:: console

[user@dom0 ~]$ qvm-template-upgrade --template=fedora-<old>

By default, the clone is named by replacing the release number in the source name, e.g. ``fedora-41`` becomes ``fedora-42`` and ``fedora-41-minimal`` becomes ``fedora-42-minimal``. Use ``--new-name=<NAME>`` to choose a different name, and ``--dry-run`` to preview the planned upgrade without creating a clone.

After the upgrade completes, remember to :ref:`switch everything that was set to the old template to the new template <user/templates/templates:switching>` and, optionally, make the new template the global default and uninstall the old template, as described in the manual instructions below. Use the manual instructions if you need finer control over the upgrade process or if the automated upgrade fails.

Summary instructions for standard Fedora templates
--------------------------------------------------

Expand Down