Skip to content

Document Debian 13 System VM template and built-in templates #701

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
weizhouapache wants to merge 8 commits into
base: main
Choose a base branch
from
+54 −16
Open

Document Debian 13 System VM template and built-in templates #701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1cd2045
Update docs for Debian 13 system VM template and built-in templates
weizhouapache Nov 10, 2026
8712009
Point System VM template variables to the 24.0 release
weizhouapache Nov 10, 2026
d56a566
Document the Debian 13 built-in templates in the quick install guide
weizhouapache Nov 10, 2026
5a4aac6
Update source/_global.rst
weizhouapache Nov 10, 2026
821ce5e
Note that upgrades need the Debian 13 template registered manually
weizhouapache Nov 12, 2026
16d0090
Link the built-in template upgrade note and document VMware template …
weizhouapache Nov 12, 2026
352e4cd
Move VMware template settings into a note in the quick install guide
weizhouapache Nov 12, 2026
835f9ec
Merge VMware template settings into the built-in template note
weizhouapache Nov 12, 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
24 changes: 12 additions & 12 deletions source/_global.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,20 @@

.. Latest version systemvm template name

.. |sysvm64-version| replace:: 4.22.0
.. |sysvm64-name-xen| replace:: systemvm-xenserver-4.22.0-x86_64
.. |sysvm64-name-kvm| replace:: systemvm-kvm-4.22.0-x86_64
.. |sysvm64-name-vmware| replace:: systemvm-vmware-4.22.0-x86_64
.. |sysvm64-name-hyperv| replace:: systemvm-hyperv-4.22.0-x86_64
.. |sysvm64-name-ovm| replace:: systemvm-ovm-4.22.0-x86_64
.. |sysvm64-version| replace:: 24.0
.. |sysvm64-name-xen| replace:: systemvm-xenserver-24.0-x86_64
.. |sysvm64-name-kvm| replace:: systemvm-kvm-24.0-x86_64
.. |sysvm64-name-vmware| replace:: systemvm-vmware-24.0-x86_64
.. |sysvm64-name-hyperv| replace:: systemvm-hyperv-24.0-x86_64
.. |sysvm64-name-ovm| replace:: systemvm-ovm-24.0-x86_64

.. Latest version systemvm template URL
.. |sysvm64-url-xen| replace:: http://download.cloudstack.org/systemvm/4.22/systemvmtemplate-4.22.0-x86_64-xen.vhd.bz2
.. |sysvm64-url-kvm| replace:: http://download.cloudstack.org/systemvm/4.22/systemvmtemplate-4.22.0-x86_64-kvm.qcow2.bz2
.. |sysvm64-url-kvm-aarch64| replace:: http://download.cloudstack.org/systemvm/4.22/systemvmtemplate-4.22.0-aarch64-kvm.qcow2.bz2
.. |sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/4.22/systemvmtemplate-4.22.0-x86_64-vmware.ova
.. |sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/4.22/systemvmtemplate-4.22.0-x86_64-hyperv.vhd.zip
.. |sysvm64-url-ovm| replace:: http://download.cloudstack.org/systemvm/4.22/systemvmtemplate-4.22.0-x86_64-ovm.raw.bz2
.. |sysvm64-url-xen| replace:: http://download.cloudstack.org/systemvm/24/systemvmtemplate-24.0-x86_64-xen.vhd.bz2
.. |sysvm64-url-kvm| replace:: http://download.cloudstack.org/systemvm/24/systemvmtemplate-24.0-x86_64-kvm.qcow2.bz2
.. |sysvm64-url-kvm-aarch64| replace:: http://download.cloudstack.org/systemvm/24/systemvmtemplate-24.0-aarch64-kvm.qcow2.bz2
.. |sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/24/systemvmtemplate-24.0-x86_64-vmware.ova
.. |sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/24/systemvmtemplate-24.0-x86_64-hyperv.vhd.zip
.. |sysvm64-url-ovm| replace:: http://download.cloudstack.org/systemvm/24/systemvmtemplate-24.0-x86_64-ovm.raw.bz2

.. Images

Expand Down
2 changes: 1 addition & 1 deletion source/adminguide/systemvm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The System VM Template
The System VMs come from a single Template. The System VM has the
following characteristics:

- Debian 12(bookwork), 6.1.0 kernel with the latest security
- Debian 13 (trixie) with its default kernel and the latest security
patches from the Debian security APT repository

- Has a minimal set of packages installed thereby reducing the attack
Expand Down
4 changes: 2 additions & 2 deletions source/installguide/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1871,7 +1871,7 @@ of your network. When the initialization has completed successfully, the
administrator's Dashboard should be displayed in the CloudStack UI.

#. Verify that the system is ready. In the left navigation bar, select
Templates. Click on the CentOS 5.5 (64bit) no Gui (KVM) Template.
Templates. Click on the Debian 13 (64-bit) genericcloud (KVM) Template.
Check to be sure that the status is "Download Complete." Do not
proceed to the next step until this status is displayed.

Expand All @@ -1882,7 +1882,7 @@ administrator's Dashboard should be displayed in the CloudStack UI.
#. Choose the zone you just added.

#. In the Template selection, choose the Template to use in the instance.
If this is a fresh installation, likely only the provided CentOS
If this is a fresh installation, likely only the provided Debian 13
Template is available.

#. Select a service offering. Be sure that the hardware you have
Expand Down
40 changes: 39 additions & 1 deletion source/quickinstallationguide/qig.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -756,8 +756,46 @@ That's it, you are done with installation of your Apache CloudStack demo cloud.
To check the health of your CloudStack installation, go to Infrastructure --> System VMs and refresh
the UI from time to time - you should see “S-1-VM” and “V-2-VM” system VMs (SSVM and CPVM) in State=Running and Agent State=Up

After that you can go to Images --> Templates, click on the built-in Template named "CentOS 5.5(64-bit) no GUI (KVM)",
After that you can go to Images --> Templates, click on the built-in Template named "Debian 13 (64-bit) genericcloud (KVM)",
then click on "Zones" tab - and observe how the Status is moving from a few percents downloaded up to fully downloaded,
after which the Status will show as "Download Complete" and "Ready" column will say "Yes".
After this is done, you will be able to deploy an Instance from this Template.

Debian 13 Built-in Template
~~~~~~~~~~~~~~~~~~~~~~~~~~~
The built-in templates are Debian 13 (trixie) cloud images, patched for CloudStack, which

@harikrishna-patnala harikrishna-patnala Nov 11, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weizhouapache please mention that upgrades will not have this template and it needs to manually registered.

@weizhouapache weizhouapache Nov 12, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @harikrishna-patnala
added now

replace the CentOS 5.x templates of earlier releases. Each hypervisor has its own template:

#. KVM: "Debian 13 (64-bit) genericcloud (KVM)"
#. XenServer: "Debian 13 (64-bit) genericcloud (XenServer)"
#. VMware: "Debian 13 (64-bit) genericcloud (vSphere)"

The template for your hypervisor is downloaded to secondary storage the first time it is
used, so the first Instance deployment can take several minutes. Wait until the template
shows "Download Complete" and "Ready" before deploying an Instance from it.

.. note::
Upgrades from earlier releases do not get the built-in Debian 13 templates. Register the
Debian 13 template for your hypervisor manually, as described in
`Uploading Templates from a remote HTTP server <../adminguide/templates.html#uploading-templates-from-a-remote-http-server>`_.

The VMware template uses the vmxnet3 NIC adapter and the pvscsi root disk controller. The guest
kernel has no driver for the default e1000 NIC. These are set as the template details
``nicAdapter`` and ``rootDiskController``.

The templates include the guest agent for each hypervisor:

#. KVM: QEMU guest agent (``qemu-guest-agent``)
#. VMware: open-vm-tools (``open-vm-tools``)
#. XenServer: XenServer guest utilities (``xe-guest-utilities``)

cloud-init supports the ConfigDrive and CloudStack datasources.

The default user is ``debian``. Password and SSH key access are supported. Both can be reset from CloudStack.

SSH login as root is disabled. The root password is ``password``, and you can use it to log in from the VM console.

.. warning::
The root password of the built-in template is publicly known. Change it, or use an SSH
key, before you expose an Instance deployed from this template to a network.

Loading