Guest OS rules by BryanMLima · Pull Request #10098 · apache/cloudstack · GitHub

Description

Currently, ACS provides a feature that enables a guest OS preference for a specific host, prioritizing VMs based on its OS. However, this functionality allows VMs with different OSes to be deployed in a host with a Guest OS defined, as expected as it is only a preference configuration; this is not always desired. For example, keeping proprietary OS in the same host could reduce licensing costs.

This PR tackles this scenario, allowing JavaScript rules, using the JS interpreter introduced in #5909, to direct VMs to specific hosts based on their OS. Different from the guest OS preference, these guest OS rules will be strict. This new feature added a new field, Guest OS as JS rule in the host edit view to allow users the creation of these rules.

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

Screenshots (if appropriate):

How Has This Been Tested?

In a local lab with two hosts (host-1 and host-2) I created the guest OS rule vmGuestOs.toLowerCase().indexOf("debian") != -1 for host-2, and deployed multiple VMs using templates and ISOs.

I deployed VMs with Ubuntu and CentOS and verify that host-2 was filtered during the deployment.
I tried to migrate these VMs to host-2 and verified that it was not possible.
I deployed a Debian VM and verified that both hosts were considered in the deployment process.
I managed to migrate this VM from host-1 to host-2 and vice versa.

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

I tried to deploy VMs in the same lab without the guest OS rules defined and validated that the deployment of VMs were being done as expected.

Codecov Report

❌ Patch coverage is 12.94118% with 148 lines in your changes missing coverage. Please review.
✅ Project coverage is 18.75%. Comparing base (6bc83a3) to head (f739fd4).
⚠️ Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
...n/java/com/cloud/resource/ResourceManagerImpl.java	0.00%	43 Missing ⚠️
...om/cloud/deploy/DeploymentPlanningManagerImpl.java	0.00%	26 Missing ⚠️
.../src/main/java/com/cloud/host/dao/HostDaoImpl.java	0.00%	21 Missing and 1 partial ⚠️
...udstack/utils/jsinterpreter/GenericRuleHelper.java	30.43%	15 Missing and 1 partial ⚠️
...ud/agent/manager/allocator/impl/BaseAllocator.java	0.00%	14 Missing ⚠️
server/src/main/java/com/cloud/api/ApiDBUtils.java	0.00%	7 Missing ⚠️
...g/apache/cloudstack/api/response/HostResponse.java	0.00%	6 Missing ⚠️
.../cloud/configuration/ConfigurationManagerImpl.java	0.00%	3 Missing and 1 partial ⚠️
...oudstack/api/command/admin/host/UpdateHostCmd.java	0.00%	3 Missing ⚠️
...c/main/java/com/cloud/api/query/vo/HostJoinVO.java	0.00%	3 Missing ⚠️
... and 3 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #10098      +/-   ##
============================================
- Coverage     18.75%   18.75%   -0.01%     
  Complexity    17966    17966              
============================================
  Files          6160     6161       +1     
  Lines        552578   552699     +121     
  Branches      67348    67368      +20     
============================================
- Hits         103660   103639      -21     
- Misses       437512   437656     +144     
+ Partials      11406    11404       -2

Flag	Coverage Δ
uitests	3.53% <ø> (-0.01%)	⬇️
unittests	19.94% <12.94%> (-0.01%)	⬇️

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

☔ View full report in Codecov by Harness.
📢 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.

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

@blueorangutan package

@sureshanaparti 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.

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

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

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

@BryanMLima can you look at the conflicts?

@BryanMLima can you look at the conflicts?

I will take a look this week, apologies for disappearing 😅 .

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

@blueorangutan package

@winterhazel a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

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

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

@blueorangutan package

CLGTM

@DaanHoogland @weizhouapache @sureshanaparti can we run the CI here one last time?

@Pearl1594 can we run the CI here? Thanks.

@blueorangutan test

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

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

Test	Result	Time (s)	Test File

Co-authored-by: Fabricio Duarte <fabricio.duarte.jr@gmail.com> (cherry picked from commit 2081ac4)

BryanMLima added this to the 4.21.0 milestone Dec 12, 2024

boring-cyborg Bot added component:api component:build component:compute component:orchestration component:quota labels Dec 12, 2024

github-actions Bot added the status:has-conflicts label Jan 8, 2025

BryanMLima force-pushed the guest-os-rules branch from 4835d26 to 796ecb1 Compare January 27, 2025 18:08

github-actions Bot added status:has-conflicts and removed status:has-conflicts labels Jan 27, 2025

sureshanaparti added this to Apache CloudStack 4.21.0 Jun 5, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.21.0 Jun 5, 2025

github-actions Bot removed the status:has-conflicts label Jun 21, 2025

github-actions Bot added status:has-conflicts and removed status:has-conflicts labels Jul 3, 2025

github-actions Bot added the status:has-conflicts label Jul 15, 2025

github-actions Bot removed the status:has-conflicts label Jul 16, 2025

github-actions Bot added the status:has-conflicts label Jul 24, 2025

github-actions Bot added the status:has-conflicts label May 19, 2026

Merge remote-tracking branch 'origin/main' into guest-os-rules

8ba5272

winterhazel removed the status:has-conflicts label May 21, 2026

github-actions Bot added the status:has-conflicts label Jun 8, 2026

hsato03 self-requested a review June 8, 2026 12:54

hsato03 reviewed Jun 9, 2026

View reviewed changes

Comment thread server/src/main/java/com/cloud/deploy/DeploymentPlanningManagerImpl.java Resolved

Comment thread ui/public/locales/pt_BR.json Resolved

winterhazel added 2 commits June 9, 2026 16:41

Merge remote-tracking branch 'origin/main' into guest-os-rules

5f4c765

Address reviews

f739fd4

winterhazel removed the status:has-conflicts label Jun 9, 2026

hsato03 approved these changes Jun 9, 2026

View reviewed changes

winterhazel removed the status:needs-review label Jun 9, 2026

github-actions Bot mentioned this pull request Jun 9, 2026

[repo-status] Daily Status Report – June 9, 2026 #13386

Closed

winterhazel added the status:waiting-for-smoketest-results label Jun 12, 2026

github-actions Bot mentioned this pull request Jun 13, 2026

[repo-status] Daily Status Report — June 13, 2026 #13416

Closed

winterhazel removed the status:waiting-for-smoketest-results label Jun 15, 2026

winterhazel merged commit 2081ac4 into apache:main Jun 15, 2026
25 of 27 checks passed

This was referenced Jun 15, 2026

[repo-status] Daily Status Report — June 15, 2026 #13425

Closed

[repo-status] Daily Status Report — June 16, 2026 #13435

Closed

dhslove pushed a commit to ablecloud-team/ablestack-cloud that referenced this pull request Sep 11, 2026

Guest OS rules (apache#10098 )

e15a67a

Co-authored-by: Fabricio Duarte <fabricio.duarte.jr@gmail.com> (cherry picked from commit 2081ac4)

Guest OS rules by BryanMLima · Pull Request #10098 · apache/cloudstack · GitHub

Repository navigation

Guest OS rules - #10098

Guest OS rules#10098winterhazel merged 7 commits intoapache:mainapache/cloudstack:mainfrom scclouds:guest-os-rulesscclouds/cloudstack:guest-os-rulesCopy head branch name to clipboard

Conversation

BryanMLima commented Dec 12, 2024 • edited by winterhazel Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Screenshots (if appropriate):

How Has This Been Tested?

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

Uh oh!

codecov Bot commented Dec 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented Jan 8, 2025

Uh oh!

github-actions Bot commented Feb 1, 2025

Uh oh!

sureshanaparti commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 11, 2025

Uh oh!

blueorangutan commented Jun 12, 2025

Uh oh!

DaanHoogland commented Jun 12, 2025

Uh oh!

BryanMLima commented Jun 17, 2025

Uh oh!

github-actions Bot commented Jul 3, 2025

Uh oh!

github-actions Bot commented Jul 15, 2025

Uh oh!

github-actions Bot commented May 19, 2026

Uh oh!

winterhazel commented May 21, 2026

Uh oh!

blueorangutan commented May 21, 2026

Uh oh!

blueorangutan commented May 21, 2026

Uh oh!

github-actions Bot commented Jun 8, 2026

Uh oh!

Uh oh!

Uh oh!

winterhazel commented Jun 9, 2026

Uh oh!

hsato03 left a comment

Choose a reason for hiding this comment

Uh oh!

winterhazel commented Jun 10, 2026

Uh oh!

winterhazel commented Jun 12, 2026

Uh oh!

Pearl1594 commented Jun 12, 2026

Uh oh!

blueorangutan commented Jun 12, 2026

Uh oh!

blueorangutan commented Jun 13, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

Guest OS rules#10098
winterhazel merged 7 commits into
apache:mainfrom
scclouds:guest-os-rules

BryanMLima commented Dec 12, 2024 •
edited by winterhazel
Loading

codecov Bot commented Dec 12, 2024 •
edited
Loading