Multiple CD-ROM / ISO Support Per VM by Damans227 · Pull Request #13101 · apache/cloudstack

Damans227 · 2026-05-04T20:53:49Z

Description

Adds multiple CD-ROM support per VM on KVM. Today CloudStack allows only one ISO per VM, forcing a manual ISO-swap workflow to install Windows on KVM (Windows installer + VirtIO drivers). After this PR each VM can hold up to vm.cdrom.max.count ISOs simultaneously, each appearing as its own CD-ROM inside the guest.

What changes:

detachIso takes an optional id (required when multiple ISOs are attached).
listVirtualMachines returns isos[] and cdrommaxcount; legacy isoid still reflects the bootable ISO.
New cluster-scoped config vm.cdrom.max.count (default 1). Values above the host-advertised cap fail loudly instead of silent clamping.
KVM agent advertises its supported CD-ROM count via the host.cdrom.max.count host detail; management reads from host_details, no hardcoded hypervisor numbers in management code.
New vm_iso_map table holds extra slots; user_vm.iso_id is kept as the bootable pointer. ISO deletion is gated by both tables.

Scope: KVM only.

Design doc: https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=421957739

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):

Screen.Recording.2026-05-04.at.5.20.18.PM.mov

How Has This Been Tested?

End-to-end on a KVM lab across cap=1/2/5, plus the UI manually.
Unit tests added in TemplateManagerImplTest for slot allocation, the duplicate-attach check, and the detach-id resolution helper.

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

Set vm.cdrom.max.count above the host's advertised cap to confirm the validate-and-throw fires on attach/deploy
Tried to re-attach an already-attached ISO
Detached the bootable and non-bootable ISO in turn to confirm user_vm.iso_id and vm_iso_map stay in sync
Stopped and restarted a multi-ISO VM to confirm boot-time persistence
Confirmed legacy single-ISO API consumers (isoid in listVirtualMachines) see no functional change

…alidation

… attached ISOs

…y fetching

… duplicates

codecov · 2026-05-04T21:02:18Z

Codecov Report

❌ Patch coverage is 41.28440% with 192 lines in your changes missing coverage. Please review.
✅ Project coverage is 18.10%. Comparing base (5893ba5) to head (68ac686).

Files with missing lines	Patch %	Lines
...n/java/com/cloud/template/TemplateManagerImpl.java	39.54%	92 Missing and 15 partials ⚠️
...rc/main/java/com/cloud/vm/dao/VmIsoMapDaoImpl.java	0.00%	44 Missing ⚠️
...ava/com/cloud/api/query/dao/UserVmJoinDaoImpl.java	51.28%	13 Missing and 6 partials ⚠️
...apache/cloudstack/api/response/UserVmResponse.java	33.33%	8 Missing ⚠️
...ud/hypervisor/kvm/storage/KVMStorageProcessor.java	0.00%	7 Missing ⚠️
.../schema/src/main/java/com/cloud/vm/VmIsoMapVO.java	83.33%	3 Missing and 1 partial ⚠️
.../cloudstack/api/command/user/iso/DetachIsoCmd.java	0.00%	1 Missing ⚠️
...e/cloudstack/api/response/AttachedIsoResponse.java	95.23%	0 Missing and 1 partial ⚠️
...ervisor/kvm/resource/LibvirtComputingResource.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #13101      +/-   ##
============================================
+ Coverage     18.09%   18.10%   +0.01%     
- Complexity    16723    16770      +47     
============================================
  Files          6037     6041       +4     
  Lines        542580   542928     +348     
  Branches      66427    66489      +62     
============================================
+ Hits          98155    98307     +152     
- Misses       433399   433570     +171     
- Partials      11026    11051      +25

Flag	Coverage Δ
uitests	`3.52% <ø> (+<0.01%)`	⬆️
unittests	`19.27% <41.28%> (+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.

Damans227 · 2026-05-04T21:31:09Z

@blueorangutan package

blueorangutan · 2026-05-04T21:32:04Z

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

blueorangutan · 2026-05-04T21:45:40Z

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

…avior for listByVmId

Damans227 · 2026-05-04T22:20:54Z

@blueorangutan package

blueorangutan · 2026-05-04T22:22:05Z

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

blueorangutan · 2026-05-04T23:06:40Z

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

…ndling

…rImpl for ISO deletion checks

Damans227 · 2026-05-05T16:28:08Z

@blueorangutan package

blueorangutan · 2026-05-05T16:30:04Z

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

blueorangutan · 2026-05-05T17:24:14Z

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

Pearl1594 · 2026-05-05T21:00:23Z

+        VmIsoMapVO highest = highestCdromMapEntry(vmId);
+        return highest == null ? CDROM_PRIMARY_DEVICE_SEQ + 1 : highest.getDeviceSeq() + 1;


Is we aren't using highestCdromMapEntry() elsewhere I was wondering if we could just do:

Suggested change

VmIsoMapVO highest = highestCdromMapEntry(vmId);

return highest == null ? CDROM_PRIMARY_DEVICE_SEQ + 1 : highest.getDeviceSeq() + 1;

return _vmIsoMapDao.listByVmId(vmId).stream()

.mapToInt(VmIsoMapVO::getDeviceSeq)

.max()

.orElse(CDROM_PRIMARY_DEVICE_SEQ) + 1;

feel free to ignore.

Pearl1594

code lgtm. Left a few minor comments.

harikrishna-patnala

code LGTM

Damans227 · 2026-05-06T13:56:31Z

@blueorangutan package

blueorangutan · 2026-05-06T13:58:04Z

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

blueorangutan · 2026-05-06T14:51:04Z

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

github-actions · 2026-05-06T19:46:08Z

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

…n logic

…host IDs and improve cluster ID retrieval

…gurations during VM boot

…D from candidates based on hypervisor type

… type

Damans227 · 2026-05-14T20:41:01Z

@blueorangutan package

blueorangutan · 2026-05-14T20:42:04Z

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

blueorangutan · 2026-05-14T20:42:55Z

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

Damans227 · 2026-05-14T20:49:48Z

@blueorangutan package

blueorangutan · 2026-05-14T20:52:04Z

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

blueorangutan · 2026-05-14T21:36:43Z

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

Damans227 added 16 commits May 4, 2026 11:29

pre-allocate a second empty cdrom slot at boot (hardcoded)

d3668e2

drive cdrom slot count via vm.cdrom.max.count ConfigKey

90b415f

add vm_iso_map table + VO/DAO

0516f82

persist multi-ISO state via vm_iso_map

945f2bd

carry target cdrom slot through AttachCommand to KVM agent

9570369

enforce per-VM cdrom cap, clamp to hypervisor max

5fd487a

make detachIso accepts an ISO id

3a13ac7

expose attached ISOs as isos[] in listVirtualMachines response

b05b9f9

extract CDROM_PRIMARY_DEVICE_SEQ constant

6d2ae5a

unit tests for cdrom slot allocation logic

a44b4fb

implement multi-ISO attachment and detachment for VMs with enhanced v…

a6afd26

…alidation

implement multi-ISO display in InstanceTab with computed property for…

71fe082

… attached ISOs

add warning alert for max CDROM selections and enhance global capacit…

2ff3ce6

…y fetching

enhance ISO attachment validation to handle multiple ISOs and prevent…

e394f1c

… duplicates

refactor ISO attachment logic for detachment and validation

e7185ab

add unit tests for ISO detachment resolution and validation logic

1e5bd63

boring-cyborg Bot added component:api component:kvm component:UI labels May 4, 2026

add mock for VmIsoMapDao in UserVmJoinDaoImplTest and set lenient beh…

79e8edf

…avior for listByVmId

Damans227 added 3 commits May 4, 2026 19:32

refactor ISO attachment logic and enhance UI for multi-CDROM management

bac8122

refactor ISO attachment methods to use VM ID and improve parameter ha…

0570cf2

…ndling

remove unnecessary mock for VM ISO mapping in TemplateManagerImplTest

61396a1

implement listByIsoId method in VmIsoMapDao and update TemplateManage…

2932522

…rImpl for ISO deletion checks

Pearl1594 reviewed May 5, 2026

View reviewed changes

Comment thread server/src/main/java/com/cloud/api/query/dao/UserVmJoinDaoImpl.java

Pearl1594 reviewed May 5, 2026

View reviewed changes

Comment thread server/src/main/java/com/cloud/template/TemplateManagerImpl.java Outdated

Pearl1594 reviewed May 5, 2026

View reviewed changes

Comment thread server/src/main/java/com/cloud/template/TemplateManagerImpl.java

Pearl1594 reviewed May 5, 2026

View reviewed changes

improve logging messages for ISO deletion checks

22fae71

Pearl1594 approved these changes May 5, 2026

View reviewed changes

harikrishna-patnala approved these changes May 6, 2026

View reviewed changes

add unit tests for CD-ROM handling and enforce limits in TemplateManager

893c6df

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

Damans227 added 6 commits May 14, 2026 15:02

refactor: update configuration value handling and improve notificatio…

3ea7edf

…n logic

refactor: rename CD-ROM references to ISO and update related logic

aca4d84

refactor: enhance effective CD-ROM max count logic to handle missing …

fdc33d4

…host IDs and improve cluster ID retrieval

refactor: enhance effective CD-ROM max count logic to handle misconfi…

fa84824

…gurations during VM boot

refactor: enhance effective CD-ROM max count logic to retrieve host I…

80e87df

…D from candidates based on hypervisor type

refactor: enhance host ID retrieval logic for VMs based on hypervisor…

a38c383

… type

Merge remote-tracking branch 'upstream/main' into fr283-multi-cdrom

68ac686

		VmIsoMapVO highest = highestCdromMapEntry(vmId);
		return highest == null ? CDROM_PRIMARY_DEVICE_SEQ + 1 : highest.getDeviceSeq() + 1;

-        VmIsoMapVO highest = highestCdromMapEntry(vmId);
-        return highest == null ? CDROM_PRIMARY_DEVICE_SEQ + 1 : highest.getDeviceSeq() + 1;
+     return _vmIsoMapDao.listByVmId(vmId).stream()
+    .mapToInt(VmIsoMapVO::getDeviceSeq)
+    .max()
+    .orElse(CDROM_PRIMARY_DEVICE_SEQ) + 1;

Conversation

Damans227 commented May 4, 2026 • edited 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 May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Damans227 commented May 4, 2026

Uh oh!

blueorangutan commented May 4, 2026

Uh oh!

blueorangutan commented May 4, 2026

Uh oh!

Damans227 commented May 4, 2026

Uh oh!

blueorangutan commented May 4, 2026

Uh oh!

blueorangutan commented May 4, 2026

Uh oh!

Damans227 commented May 5, 2026

Uh oh!

blueorangutan commented May 5, 2026

Uh oh!

blueorangutan commented May 5, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Pearl1594 May 5, 2026

Choose a reason for hiding this comment

Uh oh!

Pearl1594 left a comment

Choose a reason for hiding this comment

Uh oh!

harikrishna-patnala left a comment

Choose a reason for hiding this comment

Uh oh!

Damans227 commented May 6, 2026

Uh oh!

blueorangutan commented May 6, 2026

Uh oh!

blueorangutan commented May 6, 2026

Uh oh!

github-actions Bot commented May 6, 2026

Uh oh!

Damans227 commented May 14, 2026

Uh oh!

blueorangutan commented May 14, 2026

Uh oh!

blueorangutan commented May 14, 2026

Uh oh!

Damans227 commented May 14, 2026

Uh oh!

blueorangutan commented May 14, 2026

Uh oh!

blueorangutan commented May 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Damans227 commented May 4, 2026 •

edited

Loading

codecov Bot commented May 4, 2026 •

edited

Loading