Add volume group handling

api/src/main/java/com/cloud/agent/api/to/DiskTO.java

@@ -47,16 +47,18 @@ public class DiskTO {
     private String path;
     private Volume.Type type;
     private Map<String, String> _details;
+    private int groupNumber;
 
     public DiskTO() {
-
+        this.groupNumber = -1;
     }
 
     public DiskTO(DataTO data, Long diskSeq, String path, Volume.Type type) {
         this.data = data;
         this.diskSeq = diskSeq;
         this.path = path;
         this.type = type;
+        this.groupNumber = -1;
     }
 
     public DataTO getData() {
@@ -98,4 +100,12 @@ public void setDetails(Map<String, String> details) {
     public Map<String, String> getDetails() {
         return _details;
     }
+
+    public int getGroupNumber() {
+        return groupNumber;
+    }
+
+    public void setGroupNumber(int groupNumber) {
+        this.groupNumber = groupNumber;
+    }
 }

api/src/main/java/com/cloud/vm/VmDetailConstants.java

@@ -72,6 +72,7 @@ public interface VmDetailConstants {
     String IP6_ADDRESS = "ip6Address";
     String DISK = "disk";
     String DISK_OFFERING = "diskOffering";
+    String VOLUME_GROUP = "volumeGroup";
 
     String DEPLOY_AS_IS_CONFIGURATION = "configurationId";
     String KEY_PAIR_NAMES = "keypairnames";

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -459,6 +459,8 @@ public class ApiConstants {
     public static final String IS_VOLATILE = "isvolatile";
     public static final String VOLUME_ID = "volumeid";
     public static final String VOLUMES = "volumes";
+    public static final String VOLUME_GROUP = "volumegroup";
+    public static final String USE_CONTROLLER_CONFIGURATION = "usecontrollerconfiguration";
     public static final String ZONE = "zone";
     public static final String ZONE_ID = "zoneid";
     public static final String ZONE_NAME = "zonename";

api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ImportUnmanagedInstanceCmd.java

@@ -158,6 +158,12 @@ public class ImportUnmanagedInstanceCmd extends BaseAsyncCmd {
             description = "VM is imported despite some of its NIC's MAC addresses are already present")
     private Boolean forced;
 
+    @Parameter(name = ApiConstants.USE_CONTROLLER_CONFIGURATION,
+            type = CommandType.BOOLEAN,
+            description = "volumes automatically get volume groups based on their current controller connections",
+            since="4.17.0")
+    private Boolean useControllerConfiguration;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -259,6 +265,20 @@ public Map<String, Long> getDataDiskToDiskOfferingList() {
         return dataDiskToDiskOfferingMap;
     }
 
+    public Map<String, Integer> getVolumeGroups() {
+        Map<String, Integer> dataDiskVolumeGroups = new HashMap<>();
+        if (MapUtils.isNotEmpty(dataDiskToDiskOfferingList)) {
+            for (Map<String, String> entry : (Collection<Map<String, String>>)dataDiskToDiskOfferingList.values()) {
+                String disk = entry.get(VmDetailConstants.DISK);
+                if(entry.get(VmDetailConstants.VOLUME_GROUP) != null){
+                    Integer volumeGroup = Integer.parseInt(entry.get(VmDetailConstants.VOLUME_GROUP));
+                    dataDiskVolumeGroups.put(disk, volumeGroup);
+                }
+            }
+        }
+        return dataDiskVolumeGroups;
+    }
+
     public Map<String, String> getDetails() {
         if (MapUtils.isEmpty(details)) {
             return new HashMap<String, String>();
@@ -316,4 +336,8 @@ public long getEntityOwnerId() {
         }
         return accountId;
     }
+
+    public Boolean isUseControllerConfiguration() {
+        return BooleanUtils.isTrue(this.useControllerConfiguration);
+    }
 }

api/src/main/java/org/apache/cloudstack/api/command/user/volume/AttachVolumeCmd.java

@@ -62,6 +62,9 @@ public class AttachVolumeCmd extends BaseAsyncCmd implements UserCmd {
             required=true, description="    the ID of the virtual machine")
     private Long virtualMachineId;
 
+    @Parameter(name = ApiConstants.VOLUME_GROUP, type = CommandType.INTEGER, required = false, description = "group of volume", since = "4.17.0")
+    private int volumeGroup=-1;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -116,6 +119,10 @@ public String getEventDescription() {
         return  "attaching volume: " + this._uuidMgr.getUuid(Volume.class, getId()) + " to vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId());
     }
 
+    public int getVolumeGroup() {
+        return volumeGroup;
+    }
+
     @Override
     public void execute() {
         CallContext.current().setEventDetails("Volume Id: " + this._uuidMgr.getUuid(Volume.class, getId()) + " VmId: " + this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId()));

engine/api/src/main/java/org/apache/cloudstack/engine/orchestration/service/VolumeOrchestrationService.java

@@ -163,10 +163,11 @@ List<DiskProfile> allocateTemplatedVolumes(Type type, String name, DiskOffering
      * @param poolId ID of pool in which volume is stored
      * @param path image path of the volume
      * @param chainInfo chain info for the volume. Hypervisor specific.
+     * @param volumeGroup group of volume
      * @return  DiskProfile of imported volume
      */
     DiskProfile importVolume(Type type, String name, DiskOffering offering, Long size, Long minIops, Long maxIops, VirtualMachine vm, VirtualMachineTemplate template,
-                             Account owner, Long deviceId, Long poolId, String path, String chainInfo);
+                             Account owner, Long deviceId, Long poolId, String path, String chainInfo, Integer volumeGroup);
 
     /**
      * Unmanage VM volumes

engine/components-api/src/main/java/com/cloud/vm/VmWorkAttachVolume.java

@@ -21,11 +21,13 @@ public class VmWorkAttachVolume extends VmWork {
 
     private Long volumeId;
     private Long deviceId;
+    private int groupNumber;
 
-    public VmWorkAttachVolume(long userId, long accountId, long vmId, String handlerName, Long volumeId, Long deviceId) {
+    public VmWorkAttachVolume(long userId, long accountId, long vmId, String handlerName, Long volumeId, Long deviceId, int groupNumber) {
         super(userId, accountId, vmId, handlerName);
         this.volumeId = volumeId;
         this.deviceId = deviceId;
+        this.groupNumber = groupNumber;
     }
 
     public Long getVolumeId() {
@@ -35,4 +37,8 @@ public Long getVolumeId() {
     public Long getDeviceId() {
         return deviceId;
     }
-}
+
+    public int getGroupNumber() {
+        return groupNumber;
+    }
+}

engine/orchestration/src/main/java/org/apache/cloudstack/engine/orchestration/VolumeOrchestrator.java

@@ -126,6 +126,7 @@
 import com.cloud.storage.dao.VMTemplateDetailsDao;
 import com.cloud.storage.dao.VolumeDao;
 import com.cloud.storage.dao.VolumeDetailsDao;
+import com.cloud.storage.dao.VolumeGroupDao;
 import com.cloud.template.TemplateManager;
 import com.cloud.template.VirtualMachineTemplate;
 import com.cloud.user.Account;
@@ -234,6 +235,7 @@ public enum UserVmCloneType {
     @Inject
     VolumeApiService _volumeApiService;
     @Inject
+    private VolumeGroupDao volumeGroupDao;
     PassphraseDao passphraseDao;
 
     @Inject
@@ -2073,7 +2075,7 @@ public void updateVolumeDiskChain(long volumeId, String path, String chainInfo,
     @Override
     public DiskProfile importVolume(Type type, String name, DiskOffering offering, Long size, Long minIops, Long maxIops,
                                     VirtualMachine vm, VirtualMachineTemplate template, Account owner,
-                                    Long deviceId, Long poolId, String path, String chainInfo) {
+                                    Long deviceId, Long poolId, String path, String chainInfo, Integer volumeGroup) {
         if (size == null) {
             size = offering.getDiskSize();
         } else {
@@ -2120,6 +2122,11 @@ public DiskProfile importVolume(Type type, String name, DiskOffering offering, L
         vol.setState(Volume.State.Ready);
         vol.setAttached(new Date());
         vol = _volsDao.persist(vol);
+
+        if (volumeGroup != null) {
+            volumeGroupDao.addVolumeToGroup(vm.getId(), vol.getId(), vol.getDeviceId(), volumeGroup);
+        }
+
         return toDiskProfile(vol, offering);
     }
 
@@ -2142,6 +2149,7 @@ public void doInTransactionWithoutResult(TransactionStatus status) {
                         s_logger.debug(String.format("Skipping Destroy for the volume [%s] as it is in [%s] state.", volToString, vol.getState().toString()));
                     } else {
                         volService.unmanageVolume(vol.getId());
+                        volumeGroupDao.deleteVolumeFromGroup(vol.getId());
                     }
                 }
             }

engine/schema/src/main/java/com/cloud/storage/VolumeGroupVO.java

@@ -0,0 +1,86 @@
+/*
+ * 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.storage;
+
+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 org.apache.cloudstack.api.InternalIdentity;
+
+@Entity
+@Table(name = "volume_group")
+public class VolumeGroupVO implements InternalIdentity{
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    @Column(name = "id")
+    private long id;
+
+    @Column(name = "vm_id")
+    private long vmId;
+
+    @Column(name = "volume_id")
+    private long volumeId;
+
+    @Column(name = "group_number")
+    private int groupNumber;
+
+
+    public VolumeGroupVO() {}
+
+    public VolumeGroupVO(long vmId, long volumeId, int groupNumber) {
+        this.vmId = vmId;
+        this.volumeId = volumeId;
+        this.groupNumber = groupNumber;
+    }
+
+    public long getId() {
+        return id;
+    }
+
+    public void setId(long id) {
+        this.id = id;
+    }
+
+    public long getVmId() {
+        return vmId;
+    }
+
+    public void setVmId(long vmId) {
+        this.vmId = vmId;
+    }
+
+    public int getGroupNumber() {
+        return groupNumber;
+    }
+
+    public void setGroupNumber(int groupNumber) {
+        this.groupNumber = groupNumber;
+    }
+
+    public long getVolumeId() {
+        return volumeId;
+    }
+
+    public void setVolumeId(long volumeId) {
+        this.volumeId = volumeId;
+    }
+}

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

@@ -0,0 +1,29 @@
+/*
+ * 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.storage.dao;
+
+import com.cloud.utils.db.GenericDao;
+import com.cloud.storage.VolumeGroupVO;
+
+
+public interface VolumeGroupDao extends GenericDao<VolumeGroupVO, Long> {
+    public void addVolumeToGroup(long vmId, long volumeId, long deviceId, int groupNumber);
+    public void deleteVolumeFromGroup(long volumeId);
+    public VolumeGroupVO findByVmAndVolume(long vmId, long volumeId);
+}

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

@@ -0,0 +1,69 @@
+/*
+ * 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.storage.dao;
+
+import com.cloud.utils.db.GenericDaoBase;
+import com.cloud.storage.VolumeGroupVO;
+import com.cloud.utils.db.SearchBuilder;
+import com.cloud.utils.db.SearchCriteria;
+
+
+public class VolumeGroupDaoImpl extends GenericDaoBase<VolumeGroupVO, Long> implements VolumeGroupDao {
+    protected final SearchBuilder<VolumeGroupVO> allFieldsSearch;
+    private static final String VOLUME_ID = "volumeId";
+    private static final String VM_ID = "vmId";
+    private static final String GROUP_NUMBER = "groupNumber";
+
+    public VolumeGroupDaoImpl(){
+        allFieldsSearch = createSearchBuilder();
+        allFieldsSearch.and(VM_ID, allFieldsSearch.entity().getVmId(), SearchCriteria.Op.EQ);
+        allFieldsSearch.and(VOLUME_ID, allFieldsSearch.entity().getVolumeId(), SearchCriteria.Op.EQ);
+        allFieldsSearch.and(GROUP_NUMBER, allFieldsSearch.entity().getGroupNumber(), SearchCriteria.Op.EQ);
+        allFieldsSearch.done();
+    }
+
+    @Override
+    public void addVolumeToGroup(long vmId, long volumeId, long deviceId, int groupNumber) {
+        if (groupNumber != -1) {
+            if (deviceId == 0L) {
+                groupNumber = 0;
+            }
+            VolumeGroupVO group = new VolumeGroupVO();
+            group.setVmId(vmId);
+            group.setVolumeId(volumeId);
+            group.setGroupNumber(groupNumber);
+            persist(group);
+        }
+    }
+
+    @Override
+    public void deleteVolumeFromGroup(long volumeId) {
+        SearchCriteria<VolumeGroupVO> sc = allFieldsSearch.create();
+        sc.setParameters(VOLUME_ID, volumeId);
+        expunge(sc);
+    }
+
+    @Override
+    public VolumeGroupVO findByVmAndVolume(long vmId, long volumeId){
+        SearchCriteria<VolumeGroupVO> sc = allFieldsSearch.create();
+        sc.setParameters(VM_ID, vmId);
+        sc.setParameters(VOLUME_ID, volumeId);
+        return findOneBy(sc);
+    }
+}

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

@@ -221,6 +221,8 @@
   <bean id="vMTemplateZoneDaoImpl" class="com.cloud.storage.dao.VMTemplateZoneDaoImpl" />
   <bean id="virtualRouterProviderDaoImpl" class="com.cloud.network.dao.VirtualRouterProviderDaoImpl" />
   <bean id="vmRulesetLogDaoImpl" class="com.cloud.network.security.dao.VmRulesetLogDaoImpl" />
+  <bean id="volumeDaoImpl" class="com.cloud.storage.dao.VolumeDaoImpl" />
+  <bean id="volumeGroupDaoImpl" class="com.cloud.storage.dao.VolumeGroupDaoImpl" />
   <bean id="volumeDetailsDaoImpl" class="com.cloud.storage.dao.VolumeDetailsDaoImpl" />
   <bean id="volumeJoinDaoImpl" class="com.cloud.api.query.dao.VolumeJoinDaoImpl" />
   <bean id="volumeReservationDaoImpl" class="org.apache.cloudstack.engine.cloud.entity.api.db.dao.VolumeReservationDaoImpl" />