Multiple CD-ROM / ISO Support Per VM (#13101)

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

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

* add vm_iso_map table + VO/DAO

* persist multi-ISO state via vm_iso_map

* carry target cdrom slot through AttachCommand to KVM agent

* enforce per-VM cdrom cap, clamp to hypervisor max

* make detachIso accepts an ISO id

* expose attached ISOs as isos[] in listVirtualMachines response

* extract CDROM_PRIMARY_DEVICE_SEQ constant

* unit tests for cdrom slot allocation logic

* implement multi-ISO attachment and detachment for VMs with enhanced validation

* implement multi-ISO display in InstanceTab with computed property for attached ISOs

* add warning alert for max CDROM selections and enhance global capacity fetching

* enhance ISO attachment validation to handle multiple ISOs and prevent duplicates

* refactor ISO attachment logic for detachment and validation

* add unit tests for ISO detachment resolution and validation logic

* add mock for VmIsoMapDao in UserVmJoinDaoImplTest and set lenient behavior for listByVmId

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

* refactor ISO attachment methods to use VM ID and improve parameter handling

* remove unnecessary mock for VM ISO mapping in TemplateManagerImplTest

* add 'since' attribute to ISO detach command parameter description

* scope vm.cdrom.max.count to cluster

* add support for configurable CD-ROM count per VM and improve handling in TemplateManager

* add HostDetailsDao mock to UserVmJoinDaoImplTest

* fix: handle null poolId when loading attached ISO slots in prepareIsoForVmProfile

* implement listByIsoId method in VmIsoMapDao and update TemplateManagerImpl for ISO deletion checks

* improve logging messages for ISO deletion checks

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

* refactor: update configuration value handling and improve notification logic

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

* refactor: enhance effective CD-ROM max count logic to handle missing host IDs and improve cluster ID retrieval

* refactor: enhance effective CD-ROM max count logic to handle misconfigurations during VM boot

* refactor: enhance effective CD-ROM max count logic to retrieve host ID from candidates based on hypervisor type

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

* feat: add bootable ISO flag to AttachedIsoResponse and update UI to display it

* refactor: simplify effectiveMaxCdroms method and improve logging for CD-ROM capacity

* test: update AttachedIsoResponseTest to include bootable flag in constructor tests

* feat: include bootable flag in AttachedIsoResponse for user VMs

* feat: enhance CD-ROM management by defining empty slots for user VMs

Author: Damans227

api/src/main/java/com/cloud/host/Host.java

@@ -63,6 +63,7 @@ public static String[] toStrings(Host.Type... types) {
     String HOST_OVFTOOL_VERSION = "host.ovftool.version";
     String HOST_VIRTV2V_VERSION = "host.virtv2v.version";
     String HOST_SSH_PORT = "host.ssh.port";
+    String HOST_CDROM_MAX_COUNT = "host.cdrom.max.count";
     String GUEST_OS_CATEGORY_ID = "guest.os.category.id";
     String GUEST_OS_RULE = "guest.os.rule";
 

api/src/main/java/org/apache/cloudstack/api/command/user/iso/DetachIsoCmd.java

@@ -27,6 +27,7 @@
 import org.apache.cloudstack.api.ServerApiException;
 import org.apache.cloudstack.api.command.user.UserCmd;
 import org.apache.cloudstack.api.command.user.vm.DeployVMCmd;
+import org.apache.cloudstack.api.response.TemplateResponse;
 import org.apache.cloudstack.api.response.UserVmResponse;
 
 import com.cloud.event.EventTypes;
@@ -51,6 +52,10 @@ public class DetachIsoCmd extends BaseAsyncCmd implements UserCmd {
             description = "If true, ejects the ISO before detaching on VMware. Default: false", since = "4.15.1")
     protected Boolean forced;
 
+    @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class,
+            description = "The ID of the ISO to detach. Required when the Instance has more than one ISO attached.", since = "4.23.0")
+    protected Long id;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -104,7 +109,7 @@ public ApiCommandResourceType getApiResourceType() {
 
     @Override
     public void execute() {
-        boolean result = _templateService.detachIso(virtualMachineId, null, isForced());
+        boolean result = _templateService.detachIso(virtualMachineId, id, isForced());
         if (result) {
             UserVm userVm = _entityMgr.findById(UserVm.class, virtualMachineId);
             UserVmResponse response = _responseGenerator.createUserVmResponse(getResponseView(), "virtualmachine", userVm).get(0);

api/src/main/java/org/apache/cloudstack/api/response/AttachedIsoResponse.java

@@ -0,0 +1,76 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.apache.cloudstack.api.response;
+
+import org.apache.cloudstack.api.BaseResponse;
+
+import com.cloud.serializer.Param;
+import com.google.gson.annotations.SerializedName;
+
+public class AttachedIsoResponse extends BaseResponse {
+
+    @SerializedName("id")
+    @Param(description = "The ID of the attached ISO")
+    private String id;
+
+    @SerializedName("name")
+    @Param(description = "The name of the attached ISO")
+    private String name;
+
+    @SerializedName("displaytext")
+    @Param(description = "The display text of the attached ISO")
+    private String displayText;
+
+    @SerializedName("deviceseq")
+    @Param(description = "The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)")
+    private Integer deviceSeq;
+
+    @SerializedName("bootable")
+    @Param(description = "Whether this is the bootable ISO for the VM")
+    private Boolean bootable;
+
+    public AttachedIsoResponse() {
+    }
+
+    public AttachedIsoResponse(String id, String name, String displayText, Integer deviceSeq, boolean bootable) {
+        this.id = id;
+        this.name = name;
+        this.displayText = displayText;
+        this.deviceSeq = deviceSeq;
+        this.bootable = bootable;
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getDisplayText() {
+        return displayText;
+    }
+
+    public Integer getDeviceSeq() {
+        return deviceSeq;
+    }
+
+    public Boolean getBootable() {
+        return bootable;
+    }
+}

api/src/main/java/org/apache/cloudstack/api/response/UserVmResponse.java

@@ -166,6 +166,14 @@ public class UserVmResponse extends BaseResponseWithTagInformation implements Co
     @Param(description = "An alternate display text of the ISO attached to the Instance")
     private String isoDisplayText;
 
+    @SerializedName("isos")
+    @Param(description = "All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.", responseObject = AttachedIsoResponse.class, since = "4.23.0")
+    private List<AttachedIsoResponse> isos;
+
+    @SerializedName("isomaxcount")
+    @Param(description = "Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.", since = "4.23.0")
+    private Integer isoMaxCount;
+
     @SerializedName(ApiConstants.SERVICE_OFFERING_ID)
     @Param(description = "The ID of the service offering of the Instance")
     private String serviceOfferingId;
@@ -871,6 +879,22 @@ public void setIsoId(String isoId) {
         this.isoId = isoId;
     }
 
+    public void setIsos(List<AttachedIsoResponse> isos) {
+        this.isos = isos;
+    }
+
+    public List<AttachedIsoResponse> getIsos() {
+        return isos;
+    }
+
+    public void setIsoMaxCount(Integer isoMaxCount) {
+        this.isoMaxCount = isoMaxCount;
+    }
+
+    public Integer getIsoMaxCount() {
+        return isoMaxCount;
+    }
+
     public void setIsoName(String isoName) {
         this.isoName = isoName;
     }

api/src/test/java/org/apache/cloudstack/api/response/AttachedIsoResponseTest.java

@@ -0,0 +1,46 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.apache.cloudstack.api.response;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.junit.MockitoJUnitRunner;
+
+@RunWith(MockitoJUnitRunner.class)
+public final class AttachedIsoResponseTest {
+
+    @Test
+    public void testFullConstructorPopulatesAllFields() {
+        AttachedIsoResponse response = new AttachedIsoResponse("uuid-1", "alpine-iso", "Alpine boot", 3, true);
+        Assert.assertEquals("uuid-1", response.getId());
+        Assert.assertEquals("alpine-iso", response.getName());
+        Assert.assertEquals("Alpine boot", response.getDisplayText());
+        Assert.assertEquals(Integer.valueOf(3), response.getDeviceSeq());
+        Assert.assertTrue(response.getBootable());
+    }
+
+    @Test
+    public void testNoArgConstructorLeavesFieldsNull() {
+        AttachedIsoResponse response = new AttachedIsoResponse();
+        Assert.assertNull(response.getId());
+        Assert.assertNull(response.getName());
+        Assert.assertNull(response.getDisplayText());
+        Assert.assertNull(response.getDeviceSeq());
+        Assert.assertNull(response.getBootable());
+    }
+}

engine/components-api/src/main/java/com/cloud/template/TemplateManager.java

@@ -64,6 +64,21 @@ public interface TemplateManager {
             true,
             ConfigKey.Scope.Global);
 
+    ConfigKey<Integer> VmIsoMaxCount = new ConfigKey<Integer>("Advanced",
+            Integer.class,
+            "vm.iso.max.count", "1",
+            "Maximum number of ISOs that may be attached to a VM.",
+            true,
+            ConfigKey.Scope.Cluster);
+
+    // KVM/libvirt maps deviceSeq=3 to hdc (hda/hdb are taken by the root volume on i440fx/IDE).
+    // user_vm.iso_id has always pointed at this slot; additional cdroms live in vm_iso_map.
+    int CDROM_PRIMARY_DEVICE_SEQ = 3;
+
+    // Fallback per-VM cdrom cap when the placement host hasn't advertised host.cdrom.max.count
+    // (older agent, never-deployed VM, etc.).
+    int DEFAULT_CDROM_MAX_PER_VM = 1;
+
     static final String VMWARE_TOOLS_ISO = "vmware-tools.iso";
     static final String XS_TOOLS_ISO = "xs-tools.iso";
 

engine/schema/src/main/java/com/cloud/vm/VmIsoMapVO.java

@@ -0,0 +1,83 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package com.cloud.vm;
+
+import java.util.Date;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.Table;
+import javax.persistence.Temporal;
+import javax.persistence.TemporalType;
+
+import org.apache.cloudstack.api.InternalIdentity;
+
+@Entity
+@Table(name = "vm_iso_map")
+public class VmIsoMapVO implements InternalIdentity {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    @Column(name = "id")
+    private Long id;
+
+    @Column(name = "vm_id")
+    private long vmId;
+
+    @Column(name = "iso_id")
+    private long isoId;
+
+    @Column(name = "device_seq")
+    private int deviceSeq;
+
+    @Column(name = "created")
+    @Temporal(TemporalType.TIMESTAMP)
+    private Date created;
+
+    public VmIsoMapVO() {
+    }
+
+    public VmIsoMapVO(long vmId, long isoId, int deviceSeq) {
+        this.vmId = vmId;
+        this.isoId = isoId;
+        this.deviceSeq = deviceSeq;
+        this.created = new Date();
+    }
+
+    @Override
+    public long getId() {
+        return id;
+    }
+
+    public long getVmId() {
+        return vmId;
+    }
+
+    public long getIsoId() {
+        return isoId;
+    }
+
+    public int getDeviceSeq() {
+        return deviceSeq;
+    }
+
+    public Date getCreated() {
+        return created;
+    }
+}

engine/schema/src/main/java/com/cloud/vm/dao/VmIsoMapDao.java

@@ -0,0 +1,34 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package com.cloud.vm.dao;
+
+import java.util.List;
+
+import com.cloud.utils.db.GenericDao;
+import com.cloud.vm.VmIsoMapVO;
+
+public interface VmIsoMapDao extends GenericDao<VmIsoMapVO, Long> {
+    List<VmIsoMapVO> listByVmId(long vmId);
+
+    List<VmIsoMapVO> listByIsoId(long isoId);
+
+    VmIsoMapVO findByVmIdDeviceSeq(long vmId, int deviceSeq);
+
+    VmIsoMapVO findByVmIdIsoId(long vmId, long isoId);
+
+    int removeByVmId(long vmId);
+}