Multiple CD-ROM / ISO Support Per VM

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.")
+    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,67 @@
+// 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;
+
+    public AttachedIsoResponse() {
+    }
+
+    public AttachedIsoResponse(String id, String name, String displayText, Integer deviceSeq) {
+        this.id = id;
+        this.name = name;
+        this.displayText = displayText;
+        this.deviceSeq = deviceSeq;
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getDisplayText() {
+        return displayText;
+    }
+
+    public Integer getDeviceSeq() {
+        return deviceSeq;
+    }
+}

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

@@ -166,6 +166,10 @@ 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(ApiConstants.SERVICE_OFFERING_ID)
     @Param(description = "The ID of the service offering of the Instance")
     private String serviceOfferingId;
@@ -871,6 +875,14 @@ 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 setIsoName(String isoName) {
         this.isoName = isoName;
     }

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

@@ -64,6 +64,17 @@ public interface TemplateManager {
             true,
             ConfigKey.Scope.Global);
 
+    ConfigKey<Integer> VmCdromMaxCount = new ConfigKey<Integer>("Advanced",
+            Integer.class,
+            "vm.cdrom.max.count", "1",
+            "Maximum number of CD-ROM drives per VM.",
+            true,
+            ConfigKey.Scope.Global);
+
+    // 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;
+
     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,32 @@
+// 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);
+
+    VmIsoMapVO findByVmIdDeviceSeq(long vmId, int deviceSeq);
+
+    VmIsoMapVO findByVmIdIsoId(long vmId, long isoId);
+
+    int removeByVmId(long vmId);
+}

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

@@ -0,0 +1,80 @@
+// 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 org.springframework.stereotype.Component;
+
+import com.cloud.utils.db.GenericDaoBase;
+import com.cloud.utils.db.SearchBuilder;
+import com.cloud.utils.db.SearchCriteria;
+import com.cloud.vm.VmIsoMapVO;
+
+@Component
+public class VmIsoMapDaoImpl extends GenericDaoBase<VmIsoMapVO, Long> implements VmIsoMapDao {
+
+    private SearchBuilder<VmIsoMapVO> ListByVmId;
+    private SearchBuilder<VmIsoMapVO> ByVmIdDeviceSeq;
+    private SearchBuilder<VmIsoMapVO> ByVmIdIsoId;
+
+    protected VmIsoMapDaoImpl() {
+        ListByVmId = createSearchBuilder();
+        ListByVmId.and("vmId", ListByVmId.entity().getVmId(), SearchCriteria.Op.EQ);
+        ListByVmId.done();
+
+        ByVmIdDeviceSeq = createSearchBuilder();
+        ByVmIdDeviceSeq.and("vmId", ByVmIdDeviceSeq.entity().getVmId(), SearchCriteria.Op.EQ);
+        ByVmIdDeviceSeq.and("deviceSeq", ByVmIdDeviceSeq.entity().getDeviceSeq(), SearchCriteria.Op.EQ);
+        ByVmIdDeviceSeq.done();
+
+        ByVmIdIsoId = createSearchBuilder();
+        ByVmIdIsoId.and("vmId", ByVmIdIsoId.entity().getVmId(), SearchCriteria.Op.EQ);
+        ByVmIdIsoId.and("isoId", ByVmIdIsoId.entity().getIsoId(), SearchCriteria.Op.EQ);
+        ByVmIdIsoId.done();
+    }
+
+    @Override
+    public List<VmIsoMapVO> listByVmId(long vmId) {
+        SearchCriteria<VmIsoMapVO> sc = ListByVmId.create();
+        sc.setParameters("vmId", vmId);
+        return listBy(sc);
+    }
+
+    @Override
+    public VmIsoMapVO findByVmIdDeviceSeq(long vmId, int deviceSeq) {
+        SearchCriteria<VmIsoMapVO> sc = ByVmIdDeviceSeq.create();
+        sc.setParameters("vmId", vmId);
+        sc.setParameters("deviceSeq", deviceSeq);
+        return findOneBy(sc);
+    }
+
+    @Override
+    public VmIsoMapVO findByVmIdIsoId(long vmId, long isoId) {
+        SearchCriteria<VmIsoMapVO> sc = ByVmIdIsoId.create();
+        sc.setParameters("vmId", vmId);
+        sc.setParameters("isoId", isoId);
+        return findOneBy(sc);
+    }
+
+    @Override
+    public int removeByVmId(long vmId) {
+        SearchCriteria<VmIsoMapVO> sc = ListByVmId.create();
+        sc.setParameters("vmId", vmId);
+        return remove(sc);
+    }
+}

engine/schema/src/main/resources/META-INF/cloudstack/core/spring-engine-schema-core-daos-context.xml

@@ -108,6 +108,7 @@
   <bean id="instanceGroupJoinDaoImpl" class="com.cloud.api.query.dao.InstanceGroupJoinDaoImpl" />
   <bean id="managementServerJoinDaoImpl" class="com.cloud.api.query.dao.ManagementServerJoinDaoImpl" />
   <bean id="instanceGroupVMMapDaoImpl" class="com.cloud.vm.dao.InstanceGroupVMMapDaoImpl" />
+  <bean id="vmIsoMapDaoImpl" class="com.cloud.vm.dao.VmIsoMapDaoImpl" />
   <bean id="itWorkDaoImpl" class="com.cloud.vm.ItWorkDaoImpl" />
   <bean id="lBHealthCheckPolicyDaoImpl" class="com.cloud.network.dao.LBHealthCheckPolicyDaoImpl" />
   <bean id="lBStickinessPolicyDaoImpl" class="com.cloud.network.dao.LBStickinessPolicyDaoImpl" />

engine/schema/src/main/resources/META-INF/db/schema-42210to42300.sql

@@ -127,3 +127,17 @@ CREATE TABLE IF NOT EXISTS `cloud_usage`.`quota_tariff_usage` (
     PRIMARY KEY (`id`),
     CONSTRAINT `fk_quota_tariff_usage__tariff_id` FOREIGN KEY (`tariff_id`) REFERENCES `cloud_usage`.`quota_tariff` (`id`),
     CONSTRAINT `fk_quota_tariff_usage__quota_usage_id` FOREIGN KEY (`quota_usage_id`) REFERENCES `cloud_usage`.`quota_usage` (`id`));
+
+--- Per-VM ISO attachments. user_vm.iso_id remains as the primary/bootable ISO pointer.
+CREATE TABLE IF NOT EXISTS `cloud`.`vm_iso_map` (
+    `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+    `vm_id` bigint(20) unsigned NOT NULL COMMENT 'foreign key to user_vm',
+    `iso_id` bigint(20) unsigned NOT NULL COMMENT 'foreign key to vm_template (ISOs are templates of format ISO)',
+    `device_seq` int(10) unsigned NOT NULL COMMENT 'cdrom slot index used to derive the libvirt device label (3=hdc, 4=hdd)',
+    `created` datetime NOT NULL,
+    PRIMARY KEY (`id`),
+    UNIQUE KEY `uc_vm_iso_map__vm_iso` (`vm_id`, `iso_id`),
+    UNIQUE KEY `uc_vm_iso_map__vm_seq` (`vm_id`, `device_seq`),
+    CONSTRAINT `fk_vm_iso_map__vm_id` FOREIGN KEY (`vm_id`) REFERENCES `cloud`.`user_vm` (`id`) ON DELETE CASCADE,
+    CONSTRAINT `fk_vm_iso_map__iso_id` FOREIGN KEY (`iso_id`) REFERENCES `cloud`.`vm_template` (`id`)
+);