SystemVM template registration failure in upgrading to 4.22

[rajujith]

problem

When upgrading an environment on 4.20.1 with KVM,VMware and Xenserver hypervisors the upgrade process reported an error in upgrading HyperV SystemVM template.

Workaround : Download the template from https://download.cloudstack.org/systemvm/4.22/systemvmtemplate-4.22.0-x86_64-hyperv.vhd.zip to /usr/share/cloudstack-management/templates/systemvm/ on the management server before upgrade. Or use the old method to register the systemVM templates after restarting the service.

2025-11-14 05:55:59,844 DEBUG [c.c.u.SystemVmTemplateRegistration] (main:[]) (logid:) /usr/share/cloudstack-management/templates/systemvm/systemvmtemplate-4.22.0-x86_64-hyperv.vhd.zip is not present
2025-11-14 05:55:59,844 ERROR [o.a.c.u.s.DigestHelper] (main:[]) (logid:) Failed to calculate sha512 checksum of template
2025-11-14 05:55:59,847 ERROR [c.c.u.SystemVmTemplateRegistration] (main:[]) (logid:) Exception while registering/updating system VM templates for hypervisors in metadata com.cloud.utils.exception.CloudRuntimeException: Failed to register 4.22.0 templates for hypervisors: [vmware,xenserver,kvm-x86_64,hyperv]. Cannot upgrade system VMs
        at com.cloud.upgrade.SystemVmTemplateRegistration.registerOrUpdateSystemVmTemplate(SystemVmTemplateRegistration.java:1040)

versions

4.20.1

The steps to reproduce the bug

Upgrade 4.20.1 to .422 with KVM,VMware and Xenserver

What to do about it?

Something is wrong in the upgrade process, needs to be fixed. The issue was not seen when upgraded to RC versions of 4.22, only with KVM.

[rajujith]

More information on the environment, there is an empty hyperV cluster:

select id,hypervisor_type from cluster where removed is null;
+----+-----------------+
| id | hypervisor_type |
+----+-----------------+
|  1 | VMware          |
|  2 | XenServer       |
|  3 | KVM             |
|  4 | KVM             |
|  5 | KVM             |
|  6 | KVM             |
|  7 | KVM             |
|  8 | Hyperv          |
+----+-----------------+

select distinct(hypervisor_type) from host where removed is null and type='routing';
+-----------------+
| hypervisor_type |
+-----------------+
| VMware          |
| XenServer       |
| KVM             |
+-----------------+

[shwstppr]

Hyper-V template is not bundled with CloudStack packages. Maybe we need to:

• improve check for active hypervisors-arch in systemvm registration flow
• document - register hyper-vm template before upgrade (not sure if anyone uses it though)