Find system VM templates for CKS clusters and SharedFS honouring the preferred architecture #10946

nvazquez · 2025-06-02T17:18:57Z

Description

This PR fixes the selection of system VM templates for CKS clusters honouring the setting system.vm.preferred.architecture

Fixes: #10944

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

…itecture

rohityadavcloud

LGTM didn't test but code/path looks alright

codecov · 2025-06-02T17:26:37Z

Codecov Report

❌ Patch coverage is 24.32432% with 28 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.16%. Comparing base (823080c) to head (c3b83a4).
⚠️ Report is 76 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...bernetes/cluster/KubernetesClusterManagerImpl.java	11.53%	21 Missing and 2 partials ⚠️
...r/actionworkers/KubernetesClusterActionWorker.java	0.00%	2 Missing ⚠️
.../java/com/cloud/storage/dao/VMTemplateDaoImpl.java	83.33%	0 Missing and 1 partial ⚠️
...KubernetesClusterResourceModifierActionWorker.java	0.00%	1 Missing ⚠️
...sharedfs/lifecycle/StorageVmSharedFSLifeCycle.java	50.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.20   #10946      +/-   ##
============================================
+ Coverage     16.14%   16.16%   +0.01%     
- Complexity    13253    13280      +27     
============================================
  Files          5656     5656              
  Lines        497893   497941      +48     
  Branches      60374    60388      +14     
============================================
+ Hits          80405    80489      +84     
+ Misses       408529   408489      -40     
- Partials       8959     8963       +4

Flag	Coverage Δ
uitests	`4.00% <ø> (+<0.01%)`	⬆️
unittests	`17.01% <24.32%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

nvazquez · 2025-06-02T17:28:42Z

@blueorangutan package

engine/schema/src/main/java/com/cloud/storage/dao/VMTemplateDaoImpl.java

nvazquez · 2025-06-02T17:53:21Z

@blueorangutan package

blueorangutan · 2025-06-02T17:54:04Z

@nvazquez a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-06-02T18:01:56Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 13580

nvazquez · 2025-06-02T19:03:39Z

@blueorangutan package

blueorangutan · 2025-06-02T19:04:04Z

@nvazquez a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-06-02T19:05:01Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 13581

nvazquez · 2025-06-02T19:09:42Z

@blueorangutan package

blueorangutan · 2025-06-02T19:12:03Z

@nvazquez a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-06-02T20:26:46Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13582

harikrishna-patnala · 2025-06-05T10:59:46Z

...ernetes-service/src/main/java/com/cloud/kubernetes/cluster/KubernetesClusterManagerImpl.java

@@ -434,7 +434,8 @@ private IpAddress getSourceNatIp(Network network) {
    }

    public VMTemplateVO getKubernetesServiceTemplate(DataCenter dataCenter, Hypervisor.HypervisorType hypervisorType) {
-        VMTemplateVO template = templateDao.findSystemVMReadyTemplate(dataCenter.getId(), hypervisorType);
+        ConfigKey<String> preferredArchitecture = ResourceManager.SystemVmPreferredArchitecture;
+        VMTemplateVO template = templateDao.findSystemVMReadyTemplate(dataCenter.getId(), hypervisorType, preferredArchitecture.value());


@nvazquez we need to use valueIn() method with zoneid for the config value.

Fixed, thanks @harikrishna-patnala

harikrishna-patnala · 2025-06-05T11:00:03Z

...c/main/java/org/apache/cloudstack/storage/sharedfs/lifecycle/StorageVmSharedFSLifeCycle.java


        for (final Iterator<Hypervisor.HypervisorType> iter = hypervisors.iterator(); iter.hasNext();) {
            final Hypervisor.HypervisorType hypervisor = iter.next();
-            VMTemplateVO template = templateDao.findSystemVMReadyTemplate(zoneId, hypervisor);
+            VMTemplateVO template = templateDao.findSystemVMReadyTemplate(zoneId, hypervisor, preferredArchitecture.value());


same here, valueIn() with zoneId value

Fixed, thanks @harikrishna-patnala

rohityadavcloud · 2025-06-10T05:48:26Z

@nvazquez can you address the outstanding questions & remarks?

nvazquez · 2025-06-17T11:27:49Z

Thanks @harikrishna-patnala @rohityadavcloud - I have addressed your comments, can you please re-review?
@rohityadavcloud I've added check to compare suitable hosts for the cluster deployment against the selected template arch, so if a host doesn't match the template arch then it will be not considered

@blueorangutan package

blueorangutan · 2025-06-17T11:30:04Z

@nvazquez a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-06-17T12:39:15Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13816

nvazquez · 2025-06-18T13:53:41Z

@rohityadavcloud @harikrishna-patnala wouldn't it be better to filter out the templates that do not match the CKS ISO architecture instead of sorting them by the prefered arch setting? Anyways, I'm adding the check for CKS ISO arch vs selected template arch and failing with a proper message in case of mismatch

…the selected template arch

nvazquez · 2025-06-18T14:18:25Z

@blueorangutan package

nvazquez · 2025-07-11T11:36:36Z

@blueorangutan package

blueorangutan · 2025-07-11T11:38:03Z

@nvazquez a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-07-11T12:42:25Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 14138

DaanHoogland · 2025-07-14T07:58:41Z

@blueorangutan test

blueorangutan · 2025-07-14T08:00:04Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-07-15T00:51:38Z

[SF] Trillian test result (tid-13765)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 57877 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10946-t13765-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

weizhouapache

code lgtm

weizhouapache · 2025-07-15T04:20:15Z

...ernetes-service/src/main/java/com/cloud/kubernetes/cluster/KubernetesClusterManagerImpl.java

+            String err = String.format("The selected Kubernetes ISO %s arch (%s) doesn't match the template %s arch (%s) " +
+                            "to deploy the Kubernetes cluster",
+                    clusterKubernetesVersion.getName(), cksIso.getArch(), finalTemplate.getName(), finalTemplate.getArch());
+            throw new CloudRuntimeException(err);


Should we consider the arch of cks iso before preferred arch of zone ?

I think it could also make sense, what do you think @harikrishna-patnala @sureshanaparti @shwstppr ?

Yes that makes sense - pl address that @nvazquez - then it's ready for merging.

rohityadavcloud

LGTM tested in an mixed-arch zone with NUC9 x86 hosts and RPi5/arm64 16GB hosts.

nvazquez · 2025-07-30T19:39:31Z

Thanks for testing @rohityadavcloud - I have pushed a fix to address the comment

@blueorangutan package

blueorangutan · 2025-07-30T19:40:04Z

@nvazquez a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-07-30T20:48:02Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 14478

nvazquez · 2025-07-30T23:40:11Z

@blueorangutan test

blueorangutan · 2025-07-30T23:42:03Z

@nvazquez a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

DaanHoogland

clgtm

blueorangutan · 2025-07-31T19:48:52Z

[SF] Trillian test result (tid-13980)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 69352 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10946-t13980-kvm-ol8.zip
Smoke tests completed. 137 look OK, 4 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
ContextSuite context=TestAnnotations>:setup	`Error`	0.00	test_annotations.py
ContextSuite context=TestClusterDRS>:setup	`Error`	0.00	test_cluster_drs.py
ContextSuite context=TestDeployVirtioSCSIVM>:setup	`Error`	0.00	test_deploy_virtio_scsi_vm.py
ContextSuite context=TestDomainsServiceOfferings>:setup	`Error`	1520.91	test_domain_service_offerings.py

Find system VM templates for CKS cluster honouring the preferred arch…

81c6f5a

…itecture

nvazquez requested review from rohityadavcloud, DaanHoogland and Pearl1594 June 2, 2025 17:18

boring-cyborg bot added component:kubernetes component:storage labels Jun 2, 2025

rohityadavcloud added this to the 4.20.2 milestone Jun 2, 2025

rohityadavcloud approved these changes Jun 2, 2025

View reviewed changes

rohityadavcloud linked an issue Jun 2, 2025 that may be closed by this pull request

CKS data ISO & VM/template arch mis-match for both CKS & SharedFS features #10944

Open

Fix unit tests

778ccc1

nvazquez requested a review from shwstppr June 2, 2025 17:27

weizhouapache reviewed Jun 2, 2025

View reviewed changes

engine/schema/src/main/java/com/cloud/storage/dao/VMTemplateDaoImpl.java Outdated Show resolved Hide resolved

nvazquez mentioned this pull request Jun 2, 2025

CKS data ISO & VM/template arch mis-match for both CKS & SharedFS features #10944

Open

nvazquez added 2 commits June 2, 2025 14:31

Fix checkstyle

02de12f

Sort instead of filtering by preferred arch

70f4e26

Remove unnecesary stubs

efa3bdc

Restore java version

dabd833

nvazquez requested a review from abh1sar June 2, 2025 20:05

nvazquez changed the title ~~Find system VM templates for CKS cluster honouring the preferred architecture~~ Find system VM templates for CKS clusters and SharedFS honouring the preferred architecture Jun 2, 2025

harikrishna-patnala reviewed Jun 5, 2025

View reviewed changes

Address review comments

a44dde0

Fail and display error message in case the CKS ISO arch doesnt match …

337b0ee

…the selected template arch

DaanHoogland removed their request for review July 14, 2025 07:57

weizhouapache approved these changes Jul 15, 2025

View reviewed changes

weizhouapache self-requested a review July 15, 2025 04:18

weizhouapache reviewed Jul 15, 2025

View reviewed changes

rohityadavcloud approved these changes Jul 30, 2025

View reviewed changes

Prefer CKS ISO arch instead of the system VM setting

c3b83a4

DaanHoogland approved these changes Jul 31, 2025

View reviewed changes

rohityadavcloud merged commit ed0d606 into apache:4.20 Jul 31, 2025
26 checks passed

sureshanaparti deleted the 420-honor-cks-sysvmtmpl branch July 31, 2025 11:13

Find system VM templates for CKS clusters and SharedFS honouring the preferred architecture #10946

Find system VM templates for CKS clusters and SharedFS honouring the preferred architecture #10946

Conversation

nvazquez commented Jun 2, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

rohityadavcloud left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

nvazquez commented Jun 2, 2025

Uh oh!

Uh oh!

nvazquez commented Jun 2, 2025

Uh oh!

blueorangutan commented Jun 2, 2025

Uh oh!

blueorangutan commented Jun 2, 2025

Uh oh!

nvazquez commented Jun 2, 2025

Uh oh!

blueorangutan commented Jun 2, 2025

Uh oh!

blueorangutan commented Jun 2, 2025

Uh oh!

nvazquez commented Jun 2, 2025

Uh oh!

blueorangutan commented Jun 2, 2025

Uh oh!

blueorangutan commented Jun 2, 2025

Uh oh!

harikrishna-patnala Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

nvazquez Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

harikrishna-patnala Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

nvazquez Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

rohityadavcloud commented Jun 10, 2025

Uh oh!

nvazquez commented Jun 17, 2025

Uh oh!

blueorangutan commented Jun 17, 2025

Uh oh!

blueorangutan commented Jun 17, 2025

Uh oh!

nvazquez commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nvazquez commented Jun 18, 2025

Uh oh!

nvazquez commented Jul 11, 2025

Uh oh!

blueorangutan commented Jul 11, 2025

Uh oh!

blueorangutan commented Jul 11, 2025

Uh oh!

DaanHoogland commented Jul 14, 2025

Uh oh!

blueorangutan commented Jul 14, 2025

Uh oh!

blueorangutan commented Jul 15, 2025

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

codecov bot commented Jun 2, 2025 •

edited

Loading

nvazquez commented Jun 18, 2025 •

edited

Loading