Improve vm.allocation.algorithm global setting description (#8823)

Co-authored-by: Henrique Sato <[email protected]>

Author: hsato03

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

@@ -57,6 +57,17 @@ public interface DeploymentClusterPlanner extends DeploymentPlanner {
             false,
             ConfigKey.Scope.Global);
 
+    static final ConfigKey<String> VmAllocationAlgorithm = new ConfigKey<>(
+            String.class,
+            "vm.allocation.algorithm",
+            "Advanced",
+            "random",
+            "Order in which hosts within a cluster will be considered for VM/volume allocation. The value can be 'random', 'firstfit', 'userdispersing', 'userconcentratedpod_random', 'userconcentratedpod_firstfit', or 'firstfitleastconsumed'.",
+            true,
+            ConfigKey.Scope.Global, null, null, null, null, null,
+            ConfigKey.Kind.Select,
+            "random,firstfit,userdispersing,userconcentratedpod_random,userconcentratedpod_firstfit,firstfitleastconsumed");
+
     /**
      * This is called to determine list of possible clusters where a virtual
      * machine can be deployed.

server/src/main/java/com/cloud/configuration/Config.java

@@ -918,16 +918,6 @@ public enum Config {
             "1",
             "Weight for user dispersion heuristic (as a value between 0 and 1) applied to resource allocation during vm deployment. Weight for capacity heuristic will be (1 - weight of user dispersion)",
             null),
-    VmAllocationAlgorithm(
-            "Advanced",
-            ManagementServer.class,
-            String.class,
-            "vm.allocation.algorithm",
-            "random",
-            "'random', 'firstfit', 'userdispersing', 'userconcentratedpod_random', 'userconcentratedpod_firstfit', 'firstfitleastconsumed' : Order in which hosts within a cluster will be considered for VM/volume allocation.",
-            null,
-            ConfigKey.Kind.Select,
-            "random,firstfit,userdispersing,userconcentratedpod_random,userconcentratedpod_firstfit,firstfitleastconsumed"),
     VmDeploymentPlanner(
             "Advanced",
             ManagementServer.class,

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

@@ -567,7 +567,7 @@ public boolean canHandle(VirtualMachineProfile vm, DeploymentPlan plan, ExcludeL
     @Override
     public boolean configure(String name, Map<String, Object> params) throws ConfigurationException {
         super.configure(name, params);
-        allocationAlgorithm = configDao.getValue(Config.VmAllocationAlgorithm.key());
+        allocationAlgorithm = VmAllocationAlgorithm.value();
         globalDeploymentPlanner = configDao.getValue(Config.VmDeploymentPlanner.key());
         String configValue;
         if ((configValue = configDao.getValue(Config.ImplicitHostTags.key())) != null) {
@@ -594,6 +594,6 @@ public String getConfigComponentName() {
 
     @Override
     public ConfigKey<?>[] getConfigKeys() {
-        return new ConfigKey<?>[] {ClusterCPUCapacityDisableThreshold, ClusterMemoryCapacityDisableThreshold, ClusterThresholdEnabled};
+        return new ConfigKey<?>[] {ClusterCPUCapacityDisableThreshold, ClusterMemoryCapacityDisableThreshold, ClusterThresholdEnabled, VmAllocationAlgorithm};
     }
 }

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

@@ -151,6 +151,7 @@ public class FirstFitPlannerTest {
     public void setUp() {
         ConfigKey.init(configDepot);
 
+        when(configDepot.global()).thenReturn(configDao);
         when(configDao.getValue(Mockito.anyString())).thenReturn(null);
         when(configDao.getValue(Config.ImplicitHostTags.key())).thenReturn("GPU");
 
@@ -242,8 +243,6 @@ public void checkClusterReorderingForStartVMWithThresholdCheckDisabled() throws
     }
 
     private List<Long> initializeForClusterThresholdDisabled() {
-        when(configDepot.global()).thenReturn(configDao);
-
         ConfigurationVO config = mock(ConfigurationVO.class);
         when(config.getValue()).thenReturn(String.valueOf(false));
         when(configDao.findById(DeploymentClusterPlanner.ClusterThresholdEnabled.key())).thenReturn(config);