handling deployvm API (#61)

deployVirtualMachine API changes
apache · nvazquez · May 28, 2020 · May 29, 2020 · May 29, 2020 · Jun 3, 2020
commit 62d320e920ea4b05b2d084fd6bbc47ac2eaff802
diff --git a/api/src/main/java/com/cloud/vm/NicProfile.java b/api/src/main/java/com/cloud/vm/NicProfile.java
@@ -52,6 +52,8 @@ public class NicProfile implements InternalIdentity, Serializable {
     Integer networkRate;
     boolean isSecurityGroupEnabled;
 
+    Integer orderIndex;
+
     // IPv4
     String iPv4Address;
     String iPv4Netmask;
@@ -381,6 +383,14 @@ public void setRequestedIPv6(String requestedIPv6) {
         this.requestedIPv6 = requestedIPv6;
     }
 
+    public Integer getOrderIndex() {
+        return orderIndex;
+    }
+
+    public void setOrderIndex(Integer orderIndex) {
+        this.orderIndex = orderIndex;
+    }
+
     //
     // OTHER METHODS
     //
@@ -410,6 +420,8 @@ public void deallocate() {
         broadcastUri = null;
         isolationUri = null;
 
+        orderIndex = null;
+
     }
 
     @Override

diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java
@@ -50,6 +50,7 @@
 import org.apache.cloudstack.api.response.UserVmResponse;
 import org.apache.cloudstack.api.response.ZoneResponse;
 import org.apache.cloudstack.context.CallContext;
+import org.apache.commons.collections.CollectionUtils;
 import org.apache.commons.collections.MapUtils;
 import org.apache.log4j.Logger;
 
@@ -71,6 +72,8 @@
 import com.cloud.utils.net.Dhcp;
 import com.cloud.utils.net.NetUtils;
 import com.cloud.vm.VirtualMachine;
+import com.cloud.vm.VmDetailConstants;
+import com.google.common.base.Strings;
 
 @APICommand(name = "deployVirtualMachine", description = "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
         requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
@@ -225,6 +228,12 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
     @LogLevel(LogLevel.Log4jLevel.Off)
     private Map vAppProperties;
 
+    @Parameter(name = ApiConstants.NIC_NETWORK_LIST, type = CommandType.MAP, since = "4.15",
+            description = "used to specify the vApp network mapping." +
+                    " Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid")
+    @LogLevel(LogLevel.Log4jLevel.Off)
+    private Map vAppNetworks;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -310,7 +319,6 @@ public ApiConstants.BootMode getBootMode() {
         return null;
     }
 
-
     public Map<String, String> getVmProperties() {
         Map<String, String> map = new HashMap<>();
         if (MapUtils.isNotEmpty(vAppProperties)) {
@@ -324,6 +332,30 @@ public Map<String, String> getVmProperties() {
         return map;
     }
 
+    public Map<Integer, Long> getVmNetworkMap() {
+        Map<Integer, Long> map = new HashMap<>();
+        Collection parameterCollection = vAppNetworks.values();
+        Iterator iterator = parameterCollection.iterator();
+        while (iterator.hasNext()) {
+            HashMap<String, String> entry = (HashMap<String, String>)iterator.next();
+            Integer nic;
+            try {
+                nic = Integer.valueOf(entry.get(VmDetailConstants.NIC));
+            } catch (NumberFormatException nfe) {
+                nic = null;
+            }
+            String networkUuid = entry.get(VmDetailConstants.NETWORK);
+            if (s_logger.isTraceEnabled()) {
+                s_logger.trace(String.format("nic, '%s', goes on net, '%s'", nic, networkUuid));
+            }
+            if (nic == null || Strings.isNullOrEmpty(networkUuid) || _entityMgr.findByUuid(Network.class, networkUuid) == null) {
+                throw new InvalidParameterValueException(String.format("Network ID: %s for NIC ID: %s is invalid", networkUuid, nic));
+            }
+            map.put(nic, _entityMgr.findByUuid(Network.class, networkUuid).getId());
+        }
+        return map;
+    }
+
     public String getGroup() {
         return group;
     }
@@ -373,6 +405,13 @@ public Long getZoneId() {
     }
 
     public List<Long> getNetworkIds() {
+        if (MapUtils.isNotEmpty(vAppNetworks)) {
+            if (CollectionUtils.isNotEmpty(networkIds) || ipAddress != null || getIp6Address() != null || MapUtils.isNotEmpty(ipToNetworkList)) {
+                throw new InvalidParameterValueException(String.format("%s can't be specified along with %s, %s, %s", ApiConstants.NIC_NETWORK_LIST, ApiConstants.NETWORK_IDS, ApiConstants.IP_ADDRESS, ApiConstants.IP_NETWORK_LIST));
+            } else {
+                return new ArrayList<>();
+            }
+        }
        if (ipToNetworkList != null && !ipToNetworkList.isEmpty()) {
            if ((networkIds != null && !networkIds.isEmpty()) || ipAddress != null || getIp6Address() != null) {
                throw new InvalidParameterValueException("ipToNetworkMap can't be specified along with networkIds or ipAddress");

diff --git a/engine/api/src/main/java/org/apache/cloudstack/engine/service/api/OrchestrationService.java b/engine/api/src/main/java/org/apache/cloudstack/engine/service/api/OrchestrationService.java
@@ -55,7 +55,7 @@ public interface OrchestrationService {
      * @param memory memory to allocate in bytes
      * @param computeTags tags for the compute
      * @param rootDiskTags tags for the root disk
-     * @param networks networks that this VM should join
+     * @param networkNicMap map networks to nic profiles that this VM should join
      * @param rootDiskSize size the root disk in case of templates.
      * @return VirtualMachineEntity
      */
@@ -65,7 +65,7 @@ VirtualMachineEntity createVirtualMachine(@QueryParam("id") String id, @QueryPar
         @QueryParam("host-name") String hostName, @QueryParam("display-name") String displayName, @QueryParam("hypervisor") String hypervisor,
         @QueryParam("cpu") int cpu, @QueryParam("speed") int speed, @QueryParam("ram") long memory, @QueryParam("disk-size") Long diskSize,
         @QueryParam("compute-tags") List<String> computeTags, @QueryParam("root-disk-tags") List<String> rootDiskTags,
-        @QueryParam("network-nic-map") Map<String, NicProfile> networkNicMap, @QueryParam("deploymentplan") DeploymentPlan plan,
+        @QueryParam("network-nic-map") Map<String, List<NicProfile>> networkNicMap, @QueryParam("deploymentplan") DeploymentPlan plan,
         @QueryParam("root-disk-size") Long rootDiskSize, @QueryParam("extra-dhcp-option-map") Map<String, Map<Integer, String>> extraDhcpOptionMap,
         @QueryParam("datadisktemplate-diskoffering-map") Map<Long, DiskOffering> datadiskTemplateToDiskOfferingMap) throws InsufficientCapacityException;
 
@@ -74,7 +74,7 @@ VirtualMachineEntity createVirtualMachineFromScratch(@QueryParam("id") String id
         @QueryParam("host-name") String hostName, @QueryParam("display-name") String displayName, @QueryParam("hypervisor") String hypervisor,
         @QueryParam("os") String os, @QueryParam("cpu") int cpu, @QueryParam("speed") int speed, @QueryParam("ram") long memory, @QueryParam("disk-size") Long diskSize,
         @QueryParam("compute-tags") List<String> computeTags, @QueryParam("root-disk-tags") List<String> rootDiskTags,
-        @QueryParam("network-nic-map") Map<String, NicProfile> networkNicMap, @QueryParam("deploymentplan") DeploymentPlan plan, @QueryParam("extra-dhcp-option-map") Map<String,  Map<Integer, String>> extraDhcpOptionMap) throws InsufficientCapacityException;
+        @QueryParam("network-nic-map") Map<String, List<NicProfile>> networkNicMap, @QueryParam("deploymentplan") DeploymentPlan plan, @QueryParam("extra-dhcp-option-map") Map<String,  Map<Integer, String>> extraDhcpOptionMap) throws InsufficientCapacityException;
 
     @POST
     NetworkEntity createNetwork(String id, String name, String domainName, String cidr, String gateway);

diff --git a/...estration/src/main/java/org/apache/cloudstack/engine/orchestration/CloudOrchestrator.java b/...estration/src/main/java/org/apache/cloudstack/engine/orchestration/CloudOrchestrator.java
@@ -20,7 +20,6 @@
 
 import java.net.URL;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -159,7 +158,7 @@ public void destroyVolume(String volumeEntity) {
 
     @Override
     public VirtualMachineEntity createVirtualMachine(String id, String owner, String templateId, String hostName, String displayName, String hypervisor, int cpu,
-        int speed, long memory, Long diskSize, List<String> computeTags, List<String> rootDiskTags, Map<String, NicProfile> networkNicMap, DeploymentPlan plan,
+        int speed, long memory, Long diskSize, List<String> computeTags, List<String> rootDiskTags, Map<String, List<NicProfile>> networkNicMap, DeploymentPlan plan,
         Long rootDiskSize, Map<String, Map<Integer, String>> extraDhcpOptionMap, Map<Long, DiskOffering> dataDiskTemplateToDiskOfferingMap) throws InsufficientCapacityException {
 
         if (LOGGER.isTraceEnabled()) {
@@ -170,7 +169,7 @@ public VirtualMachineEntity createVirtualMachine(String id, String owner, String
         for (String uuid : networkNicMap.keySet()) {
             NetworkVO network = _networkDao.findByUuid(uuid);
             if(network != null){
-                networkIpMap.put(network, new ArrayList<NicProfile>(Arrays.asList(networkNicMap.get(uuid))));
+                networkIpMap.put(network, networkNicMap.get(uuid));
             }
         }
 
@@ -259,7 +258,7 @@ public VirtualMachineEntity createVirtualMachine(String id, String owner, String
 
     @Override
     public VirtualMachineEntity createVirtualMachineFromScratch(String id, String owner, String isoId, String hostName, String displayName, String hypervisor, String os,
-        int cpu, int speed, long memory, Long diskSize, List<String> computeTags, List<String> rootDiskTags, Map<String, NicProfile> networkNicMap, DeploymentPlan plan, Map<String, Map<Integer, String>> extraDhcpOptionMap)
+        int cpu, int speed, long memory, Long diskSize, List<String> computeTags, List<String> rootDiskTags, Map<String, List<NicProfile>> networkNicMap, DeploymentPlan plan, Map<String, Map<Integer, String>> extraDhcpOptionMap)
         throws InsufficientCapacityException {
 
         // VirtualMachineEntityImpl vmEntity = new VirtualMachineEntityImpl(id, owner, hostName, displayName, cpu, speed, memory, computeTags, rootDiskTags, networks, vmEntityManager);
@@ -311,7 +310,7 @@ public VirtualMachineEntity createVirtualMachineFromScratch(String id, String ow
         for (String uuid : networkNicMap.keySet()) {
             NetworkVO network = _networkDao.findByUuid(uuid);
             if(network != null){
-                networkIpMap.put(network, new ArrayList<NicProfile>(Arrays.asList(networkNicMap.get(uuid))));
+                networkIpMap.put(network, networkNicMap.get(uuid));
             }
         }
 

diff --git a/...tration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java b/...tration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java
@@ -17,6 +17,8 @@
 package org.apache.cloudstack.engine.orchestration;
 
 
+import static org.apache.commons.lang.StringUtils.isNotBlank;
+
 import java.net.URI;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -39,11 +41,6 @@
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
 
-import com.cloud.event.EventTypes;
-import com.cloud.event.UsageEventUtils;
-import com.cloud.network.dao.NetworkDetailVO;
-import com.cloud.network.dao.NetworkDetailsDao;
-import com.cloud.storage.dao.VMTemplateDetailsDao;
 import org.apache.cloudstack.acl.ControlledEntity.ACLType;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.net.NetworkPrerequisiteTO;
@@ -91,6 +88,8 @@
 import com.cloud.deploy.DeployDestination;
 import com.cloud.deploy.DeploymentPlan;
 import com.cloud.domain.Domain;
+import com.cloud.event.EventTypes;
+import com.cloud.event.UsageEventUtils;
 import com.cloud.exception.ConcurrentOperationException;
 import com.cloud.exception.ConnectionException;
 import com.cloud.exception.InsufficientAddressCapacityException;
@@ -132,6 +131,8 @@
 import com.cloud.network.dao.NetworkAccountDao;
 import com.cloud.network.dao.NetworkAccountVO;
 import com.cloud.network.dao.NetworkDao;
+import com.cloud.network.dao.NetworkDetailVO;
+import com.cloud.network.dao.NetworkDetailsDao;
 import com.cloud.network.dao.NetworkDomainDao;
 import com.cloud.network.dao.NetworkDomainVO;
 import com.cloud.network.dao.NetworkServiceMapDao;
@@ -181,6 +182,7 @@
 import com.cloud.offerings.dao.NetworkOfferingDao;
 import com.cloud.offerings.dao.NetworkOfferingDetailsDao;
 import com.cloud.offerings.dao.NetworkOfferingServiceMapDao;
+import com.cloud.storage.dao.VMTemplateDetailsDao;
 import com.cloud.user.Account;
 import com.cloud.user.ResourceLimitService;
 import com.cloud.user.User;
@@ -233,8 +235,6 @@
 import com.cloud.vm.dao.VMInstanceDao;
 import com.google.common.base.Strings;
 
-import static org.apache.commons.lang.StringUtils.isNotBlank;
-
 /**
  * NetworkManagerImpl implements NetworkManager.
  */
@@ -764,25 +764,15 @@ public void doInTransactionWithoutResult(final TransactionStatus status) throws
                 final boolean[] deviceIds = new boolean[size];
                 Arrays.fill(deviceIds, false);
 
+                List<Pair<Network, NicProfile>> profilesList = getOrderedNetworkNicProfileMapping(networks);
                 final List<NicProfile> nics = new ArrayList<NicProfile>(size);
                 NicProfile defaultNic = null;
-
                 Network nextNetwork = null;
-                for (final Map.Entry<? extends Network, List<? extends NicProfile>> network : networks.entrySet()) {
-                    nextNetwork = network.getKey();
-                    List<? extends NicProfile> requestedProfiles = network.getValue();
-                    if (requestedProfiles == null) {
-                        requestedProfiles = new ArrayList<NicProfile>();
-                    }
-                    if (requestedProfiles.isEmpty()) {
-                        requestedProfiles.add(null);
-                    }
-
-                    for (final NicProfile requested : requestedProfiles) {
-                        Pair<NicProfile, Integer> newDeviceInfo = addRequestedNicToNicListWithDeviceNumberAndRetrieveDefaultDevice( requested, deviceIds, deviceId, nextNetwork, nics, defaultNic);
-                        defaultNic = newDeviceInfo.first();
-                        deviceId = newDeviceInfo.second();
-                    }
+                for (Pair <Network, NicProfile> networkNicPair : profilesList) {
+                    nextNetwork = networkNicPair.first();
+                    Pair<NicProfile, Integer> newDeviceInfo = addRequestedNicToNicListWithDeviceNumberAndRetrieveDefaultDevice(networkNicPair.second(), deviceIds, deviceId, nextNetwork, nics, defaultNic);
+                    defaultNic = newDeviceInfo.first();
+                    deviceId = newDeviceInfo.second();
                 }
                 createExtraNics(size, nics, nextNetwork);
 
@@ -841,6 +831,42 @@ Pair<NicProfile,Integer> addRequestedNicToNicListWithDeviceNumberAndRetrieveDefa
                 return rc;
             }
 
+            /**
+             * private transaction method to get oredered list of Network and NicProfile pair
+             * @return ordered list of Network and NicProfile pair
+             * @param networks the map od networks to nic profiles list
+             */
+            private List<Pair<Network, NicProfile>> getOrderedNetworkNicProfileMapping(final LinkedHashMap<? extends Network, List<? extends NicProfile>> networks) {
+                List<Pair<Network, NicProfile>> profilesList = new ArrayList<>();
+                for (final Map.Entry<? extends Network, List<? extends NicProfile>> network : networks.entrySet()) {
+                    List<? extends NicProfile> requestedProfiles = network.getValue();
+                    if (requestedProfiles == null) {
+                        requestedProfiles = new ArrayList<NicProfile>();
+                    }
+                    if (requestedProfiles.isEmpty()) {
+                        requestedProfiles.add(null);
+                    }
+                    for (final NicProfile requested : requestedProfiles) {
+                        profilesList.add(new Pair<Network, NicProfile>(network.getKey(), requested));
+                    }
+                }
+                profilesList.sort(new Comparator<Pair<Network, NicProfile>>() {
+                    @Override
+                    public int compare(Pair<Network, NicProfile> pair1, Pair<Network, NicProfile> pair2) {
+                        int profile1Order = Integer.MAX_VALUE;
+                        int profile2Order = Integer.MAX_VALUE;
+                        if (pair1 != null && pair1.second() != null && pair1.second().getOrderIndex() != null) {
+                            profile1Order = pair1.second().getOrderIndex();
+                        }
+                        if (pair2 != null && pair2.second() != null && pair2.second().getOrderIndex() != null) {
+                            profile2Order = pair2.second().getOrderIndex();
+                        }
+                        return profile1Order - profile2Order;
+                    }
+                });
+                return profilesList;
+            }
+
             /**
              * private transaction method to run over the objects and determine nic requirements
              * @return the total numer of nics required

diff --git a/engine/schema/src/main/java/com/cloud/storage/dao/VMTemplateDetailsDaoImpl.java b/engine/schema/src/main/java/com/cloud/storage/dao/VMTemplateDetailsDaoImpl.java
@@ -17,25 +17,25 @@
 package com.cloud.storage.dao;
 
 
-import com.cloud.agent.api.storage.OVFPropertyTO;
-import com.cloud.agent.api.to.DatadiskTO;
-import com.cloud.storage.ImageStore;
-import com.cloud.utils.db.SearchBuilder;
-import com.cloud.utils.db.SearchCriteria;
-import com.cloud.utils.db.TransactionLegacy;
-import com.google.gson.Gson;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.List;
+
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.net.NetworkPrerequisiteTO;
+import org.apache.cloudstack.resourcedetail.ResourceDetailsDaoBase;
 import org.apache.commons.collections.CollectionUtils;
 import org.apache.log4j.Logger;
 import org.springframework.stereotype.Component;
 
-import org.apache.cloudstack.resourcedetail.ResourceDetailsDaoBase;
-
+import com.cloud.agent.api.storage.OVFPropertyTO;
+import com.cloud.agent.api.to.DatadiskTO;
+import com.cloud.storage.ImageStore;
 import com.cloud.storage.VMTemplateDetailVO;
-
-import java.util.ArrayList;
-import java.util.List;
+import com.cloud.utils.db.SearchBuilder;
+import com.cloud.utils.db.SearchCriteria;
+import com.cloud.utils.db.TransactionLegacy;
+import com.google.gson.Gson;
 
 @Component
 public class VMTemplateDetailsDaoImpl extends ResourceDetailsDaoBase<VMTemplateDetailVO> implements VMTemplateDetailsDao {
@@ -111,6 +111,12 @@ public List<NetworkPrerequisiteTO> listNetworkRequirementsByTemplateId(long temp
             NetworkPrerequisiteTO ovfPropertyTO = gson.fromJson(property.getValue(), NetworkPrerequisiteTO.class);
             networkPrereqs.add(ovfPropertyTO);
         }
+        networkPrereqs.sort(new Comparator<NetworkPrerequisiteTO>() {
+            @Override
+            public int compare(NetworkPrerequisiteTO o1, NetworkPrerequisiteTO o2) {
+                return o1.getInstanceID() - o2.getInstanceID();
+            }
+        });
         return networkPrereqs;
     }