Add global setting vm.distinct.hostname.scope

Author: vishesh92

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

@@ -20,6 +20,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 import com.cloud.hypervisor.Hypervisor;
 import com.cloud.utils.Pair;
@@ -144,6 +145,10 @@ public interface VMInstanceDao extends GenericDao<VMInstanceVO, Long>, StateDao<
      */
     List<String> listDistinctHostNames(long networkId, VirtualMachine.Type... types);
 
+    boolean hostNameExistsInDomainIds(String hostName, Set<Long> domainIdList);
+
+    boolean hostNameExistsInDomainIdsAccountIds(String hostName, Set<Long> accountIdList);
+
     List<VMInstanceVO> findByHostInStates(Long hostId, State... states);
 
     List<VMInstanceVO> listStartingWithNoHostId();

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

@@ -24,11 +24,13 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.stream.Collectors;
 
 import javax.annotation.PostConstruct;
 import javax.inject.Inject;
 
+import org.apache.commons.collections.CollectionUtils;
 import org.apache.log4j.Logger;
 import org.springframework.stereotype.Component;
 
@@ -294,6 +296,8 @@ protected void init() {
         DistinctHostNameSearch.selectFields(DistinctHostNameSearch.entity().getHostName());
 
         DistinctHostNameSearch.and("types", DistinctHostNameSearch.entity().getType(), SearchCriteria.Op.IN);
+        DistinctHostNameSearch.and("accounts", DistinctHostNameSearch.entity().getAccountId(), SearchCriteria.Op.IN);
+        DistinctHostNameSearch.and("domains", DistinctHostNameSearch.entity().getDomainId(), SearchCriteria.Op.IN);
         DistinctHostNameSearch.and("removed", DistinctHostNameSearch.entity().getRemoved(), SearchCriteria.Op.NULL);
         DistinctHostNameSearch.join("nicSearch", nicSearch, DistinctHostNameSearch.entity().getId(), nicSearch.entity().getInstanceId(), JoinBuilder.JoinType.INNER);
         DistinctHostNameSearch.done();
@@ -885,6 +889,20 @@ public List<String> listDistinctHostNames(long networkId, VirtualMachine.Type...
         return customSearch(sc, null);
     }
 
+    public boolean hostNameExistsInDomainIds(String hostName, Set<Long> domainIdList) {
+        SearchCriteria<String> sc = DistinctHostNameSearch.create();
+        sc.setParameters("domains", domainIdList.toArray());
+
+        return CollectionUtils.isNotEmpty(customSearch(sc, null));
+    }
+
+    public boolean hostNameExistsInDomainIdsAccountIds(String hostName, Set<Long> accountIdList) {
+        SearchCriteria<String> sc = DistinctHostNameSearch.create();
+        sc.setParameters("accounts", accountIdList.toArray());
+
+        return CollectionUtils.isNotEmpty(customSearch(sc, null));
+    }
+
     @Override
     @DB
     public boolean remove(Long id) {

server/src/main/java/com/cloud/vm/UserVmManager.java

@@ -59,6 +59,12 @@ public interface UserVmManager extends UserVmService {
             "Destroys the VM's root volume when the VM is destroyed.",
             true, ConfigKey.Scope.Domain);
 
+    ConfigKey<String> VmDistinctHostNameScope = new ConfigKey<>(String.class, "vm.distinct.hostname.scope", ConfigKey.CATEGORY_ADVANCED,
+            "network",
+            "Scope of resources to check while checking if the hostname is unique. Possible values are global, domain, subdomain, account, network.",
+            true, ConfigKey.Scope.Global, null, "VM distinct hostname scope", null, null, null, ConfigKey.Kind.Select,
+            "global,domain,subdomain,account,network");
+
     static final int MAX_USER_DATA_LENGTH_BYTES = 2048;
 
     public  static  final String CKS_NODE = "cksnode";

server/src/main/java/com/cloud/vm/UserVmManagerImpl.java

@@ -4472,18 +4472,64 @@ private Map<String, Set<Long>> getNetworkIdPerNetworkDomain(List<? extends Netwo
 
     private void checkIfHostNameUniqueInNtwkDomain(String hostName, List<? extends Network> networkList) {
         // Check that hostName is unique in the network domain
-        Map<String, Set<Long>> ntwkDomains = getNetworkIdPerNetworkDomain(networkList);
-        for (Entry<String, Set<Long>> ntwkDomain : ntwkDomains.entrySet()) {
-            for (Long ntwkId : ntwkDomain.getValue()) {
-                // * get all vms hostNames in the network
-                List<String> hostNames = _vmInstanceDao.listDistinctHostNames(ntwkId);
-                // * verify that there are no duplicates
-                if (hostNames.contains(hostName)) {
-                    throw new InvalidParameterValueException("The vm with hostName " + hostName + " already exists in the network domain: " + ntwkDomain.getKey() + "; network="
-                            + ((_networkModel.getNetwork(ntwkId) != null) ? _networkModel.getNetwork(ntwkId).getName() : "<unknown>"));
+        Set<Long> domainIdList = new HashSet<>();
+        switch (VmDistinctHostNameScope.value()) {
+            case "global":
+                // Check that hostName is unique in the zone
+                VMInstanceVO vm = _vmInstanceDao.findVMByHostName(hostName);
+                if (vm != null) {
+                    throw new InvalidParameterValueException("The vm with hostName " + hostName + " already exists in the zone");
+                }
+            case "domain":
+                // Check that hostName is unique in the domain
+                for (Network network : networkList) {
+                    domainIdList.add(network.getDomainId());
+                }
+                if (_vmInstanceDao.hostNameExistsInDomainIds(hostName, domainIdList)) {
+                    throw new InvalidParameterValueException("The vm with hostName " + hostName + " already exists in the domain");
+                }
+                break;
+            case "subdomain":
+                for (Network network : networkList) {
+                    domainIdList.add(network.getDomainId());
+                }
+                Set<Long> finalDomainIdList = new HashSet<>();
+                for (Long domainId : domainIdList) {
+                    finalDomainIdList.add(domainId);
+                    DomainVO domain = _domainDao.findById(domainId);
+                    List<Long> childDomainIds = _domainDao.getDomainChildrenIds(domain.getPath());
+                    finalDomainIdList.addAll(childDomainIds);
+                }
+
+                if (_vmInstanceDao.hostNameExistsInDomainIds(hostName, finalDomainIdList)) {
+                    throw new InvalidParameterValueException("The vm with hostName " + hostName + " already exists in the domain or subdomain");
+                }
+                break;
+            case "account":
+                // Check that hostName is unique in the account
+                Set<Long> accountIdList = new HashSet<>();
+                for (Network network : networkList) {
+                    accountIdList.add(network.getAccountId());
+                }
+                if (_vmInstanceDao.hostNameExistsInDomainIdsAccountIds(hostName, accountIdList)) {
+                    throw new InvalidParameterValueException("The vm with hostName " + hostName + " already exists in the account");
+                }
+                break;
+            default:
+                Map<String, Set<Long>> ntwkDomains = getNetworkIdPerNetworkDomain(networkList);
+                for (Entry<String, Set<Long>> ntwkDomain : ntwkDomains.entrySet()) {
+                    for (Long ntwkId : ntwkDomain.getValue()) {
+                        // * get all vms hostNames in the network
+                        List<String> hostNames = _vmInstanceDao.listDistinctHostNames(ntwkId);
+                        // * verify that there are no duplicates
+                        if (hostNames.contains(hostName)) {
+                            throw new InvalidParameterValueException("The vm with hostName " + hostName + " already exists in the network domain: " + ntwkDomain.getKey() + "; network="
+                                    + ((_networkModel.getNetwork(ntwkId) != null) ? _networkModel.getNetwork(ntwkId).getName() : "<unknown>"));
+                        }
+                    }
                 }
-            }
         }
+
     }
 
     private String generateHostName(String uuidName) {
@@ -8250,7 +8296,7 @@ public String getConfigComponentName() {
     public ConfigKey<?>[] getConfigKeys() {
         return new ConfigKey<?>[] {EnableDynamicallyScaleVm, AllowDiskOfferingChangeDuringScaleVm, AllowUserExpungeRecoverVm, VmIpFetchWaitInterval, VmIpFetchTrialMax,
                 VmIpFetchThreadPoolMax, VmIpFetchTaskWorkers, AllowDeployVmIfGivenHostFails, EnableAdditionalVmConfig, DisplayVMOVFProperties,
-                KvmAdditionalConfigAllowList, XenServerAdditionalConfigAllowList, VmwareAdditionalConfigAllowList, DestroyRootVolumeOnVmDestruction};
+                KvmAdditionalConfigAllowList, XenServerAdditionalConfigAllowList, VmwareAdditionalConfigAllowList, DestroyRootVolumeOnVmDestruction, VmDistinctHostNameScope};
     }
 
     @Override