Move configuration to Planner hierarchy

Author: Nicole Schmidt

api/src/main/java/com/cloud/deploy/DeploymentClusterPlanner.java

@@ -68,6 +68,14 @@ public interface DeploymentClusterPlanner extends DeploymentPlanner {
             ConfigKey.Kind.Select,
             "random,firstfit,userdispersing,firstfitleastconsumed");
 
+    ConfigKey<Boolean> allowRoutersOnDedicatedResources = new ConfigKey<>(
+            "Advanced",
+            Boolean.class,
+            "allow.routers.on.dedicated.resources",
+            "false",
+            "Allow deploying virtual routers on dedicated Hosts, Clusters, Pods, and Zones",
+            true);
+
     /**
      * This is called to determine list of possible clusters where a virtual
      * machine can be deployed.

engine/schema/src/main/java/com/cloud/capacity/dao/CapacityDao.java

@@ -24,13 +24,9 @@
 import com.cloud.utils.Pair;
 import com.cloud.utils.Ternary;
 import com.cloud.utils.db.GenericDao;
-import org.apache.cloudstack.framework.config.ConfigKey;
 
 public interface CapacityDao extends GenericDao<CapacityVO, Long> {
 
-    ConfigKey<Boolean> allowRoutersOnDedicatedResources =  new ConfigKey<>("Advanced", Boolean.class, "allow.routers.on.dedicated.resources", "false",
-            "Allow deploying virtual routers on dedicated Hosts, Clusters, Pods, and Zones", true);
-
     CapacityVO findByHostIdType(Long hostId, short capacityType);
 
     List<CapacityVO> listByHostIdTypes(Long hostId, List<Short> capacityTypes);
@@ -45,7 +41,7 @@ public interface CapacityDao extends GenericDao<CapacityVO, Long> {
 
     List<SummedCapacity> findNonSharedStorageForClusterPodZone(Long zoneId, Long podId, Long clusterId);
 
-    Pair<List<Long>, Map<Long, Double>> orderClustersByAggregateCapacity(long id, long vmId, short capacityType,  boolean isVr, boolean isZone);
+    Pair<List<Long>, Map<Long, Double>> orderClustersByAggregateCapacity(long id, long vmId, short capacityType,  boolean isVr, boolean allowRoutersOnDedicatedResources, boolean isZone);
 
     Ternary<Long, Long, Long> findCapacityByZoneAndHostTag(Long zoneId, String hostTag);
 

engine/schema/src/main/java/com/cloud/capacity/dao/CapacityDaoImpl.java

@@ -26,8 +26,6 @@
 
 import javax.inject.Inject;
 
-import org.apache.cloudstack.framework.config.ConfigKey;
-import org.apache.cloudstack.framework.config.Configurable;
 import org.apache.cloudstack.storage.datastore.db.PrimaryDataStoreDao;
 import org.apache.cloudstack.storage.datastore.db.StoragePoolVO;
 import org.apache.commons.collections.CollectionUtils;
@@ -51,7 +49,7 @@
 import com.cloud.utils.exception.CloudRuntimeException;
 
 @Component
-public class CapacityDaoImpl extends GenericDaoBase<CapacityVO, Long> implements CapacityDao, Configurable {
+public class CapacityDaoImpl extends GenericDaoBase<CapacityVO, Long> implements CapacityDao {
 
     private static final String ADD_ALLOCATED_SQL = "UPDATE `cloud`.`op_host_capacity` SET used_capacity = used_capacity + ? WHERE host_id = ? AND capacity_type = ?";
     private static final String SUBTRACT_ALLOCATED_SQL =
@@ -995,7 +993,7 @@ public boolean removeBy(Short capacityType, Long zoneId, Long podId, Long cluste
     }
 
     @Override
-    public Pair<List<Long>, Map<Long, Double>> orderClustersByAggregateCapacity(long id, long vmId, short capacityTypeForOrdering, boolean isVr,  boolean isZone) {
+    public Pair<List<Long>, Map<Long, Double>> orderClustersByAggregateCapacity(long id, long vmId, short capacityTypeForOrdering, boolean isVr, boolean allowRoutersOnDedicatedResources, boolean isZone) {
         TransactionLegacy txn = TransactionLegacy.currentTxn();
         PreparedStatement pstmt = null;
         List<Long> result = new ArrayList<Long>();
@@ -1007,7 +1005,7 @@ public Pair<List<Long>, Map<Long, Double>> orderClustersByAggregateCapacity(long
             sql.append(ORDER_CLUSTERS_BY_AGGREGATE_OVERCOMMIT_CAPACITY_PART1);
         }
 
-        if (isVr && allowRoutersOnDedicatedResources.value()) {
+        if (isVr && allowRoutersOnDedicatedResources) {
             sql.append(ORDER_CLUSTERS_BY_AGGREGATE_CAPACITY_INCLUDE_DEDICATED_TO_DOMAIN_JOIN_1);
         } else {
             sql.append(ORDER_CLUSTERS_BY_AGGREGATE_CAPACITY_JOIN_1);
@@ -1304,14 +1302,4 @@ public float findClusterConsumption(Long clusterId, short capacityType, long com
         }
         return 0;
     }
-
-    @Override
-    public ConfigKey<?>[] getConfigKeys() {
-        return new ConfigKey<?>[] {allowRoutersOnDedicatedResources};
-    }
-
-    @Override
-    public String getConfigComponentName() {
-        return CapacityDaoImpl.class.getSimpleName();
-    }
 }

plugins/deployment-planners/implicit-dedication/src/test/java/org/apache/cloudstack/implicitplanner/ImplicitPlannerTest.java

@@ -366,7 +366,7 @@ private void initializeForTest(VirtualMachineProfileImpl vmProfile, DataCenterDe
         clusterCapacityMap.put(2L, 2048D);
         clusterCapacityMap.put(3L, 2048D);
         Pair<List<Long>, Map<Long, Double>> clustersOrderedByCapacity = new Pair<List<Long>, Map<Long, Double>>(clustersWithEnoughCapacity, clusterCapacityMap);
-        when(capacityDao.orderClustersByAggregateCapacity(dataCenterId, 12L, Capacity.CAPACITY_TYPE_CPU, false, true)).thenReturn(clustersOrderedByCapacity);
+        when(capacityDao.orderClustersByAggregateCapacity(dataCenterId, 12L, Capacity.CAPACITY_TYPE_CPU, false, false, true)).thenReturn(clustersOrderedByCapacity);
 
         List<Long> disabledClusters = new ArrayList<Long>();
         List<Long> clustersWithDisabledPods = new ArrayList<Long>();

server/src/main/java/com/cloud/deploy/FirstFitPlanner.java

@@ -562,7 +562,7 @@ private Pair<List<Long>, Map<Long, Double>> getOrderedClustersByCapacity(long id
 
         logger.debug("CapacityType: {} is used for Cluster ordering", getCapacityTypeName(capacityType));
         if (capacityType >= 0) { // for capacityType other than COMBINED
-            return capacityDao.orderClustersByAggregateCapacity(id, vmId, capacityType, isVr, isZone);
+            return capacityDao.orderClustersByAggregateCapacity(id, vmId, capacityType, isVr, allowRoutersOnDedicatedResources.value(), isZone);
         }
 
         Long zoneId = isZone ? id : null;
@@ -695,6 +695,6 @@ public String getConfigComponentName() {
 
     @Override
     public ConfigKey<?>[] getConfigKeys() {
-        return new ConfigKey<?>[] {ClusterCPUCapacityDisableThreshold, ClusterMemoryCapacityDisableThreshold, ClusterThresholdEnabled, VmAllocationAlgorithm};
+        return new ConfigKey<?>[] {ClusterCPUCapacityDisableThreshold, ClusterMemoryCapacityDisableThreshold, ClusterThresholdEnabled, VmAllocationAlgorithm, allowRoutersOnDedicatedResources};
     }
 }

server/src/test/java/com/cloud/vm/FirstFitPlannerTest.java

@@ -373,7 +373,7 @@ private void initializeForTest(VirtualMachineProfileImpl vmProfile, DataCenterDe
         clusterCapacityMap.put(6L, 2048D);
 
         Pair<List<Long>, Map<Long, Double>> clustersOrderedByCapacity = new Pair<List<Long>, Map<Long, Double>>(clustersWithEnoughCapacity, clusterCapacityMap);
-        when(capacityDao.orderClustersByAggregateCapacity(dataCenterId, 12L, Capacity.CAPACITY_TYPE_CPU, false, true)).thenReturn(clustersOrderedByCapacity);
+        when(capacityDao.orderClustersByAggregateCapacity(dataCenterId, 12L, Capacity.CAPACITY_TYPE_CPU, false, false,true)).thenReturn(clustersOrderedByCapacity);
 
         List<Long> disabledClusters = new ArrayList<Long>();
         List<Long> clustersWithDisabledPods = new ArrayList<Long>();