new plugins: Add non-strict affinity groups (#6845)

Author: weizhouapache

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

@@ -21,7 +21,9 @@
 import org.apache.cloudstack.utils.reflectiontostringbuilderutils.ReflectionToStringBuilderUtils;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 public class DataCenterDeployment implements DeploymentPlan {
     long _dcId;
@@ -35,6 +37,7 @@ public class DataCenterDeployment implements DeploymentPlan {
     ReservationContext _context;
     List<Long> preferredHostIds = new ArrayList<>();
     boolean migrationPlan;
+    Map<Long, Integer> hostPriorities = new HashMap<>();
 
     public DataCenterDeployment(long dataCenterId) {
         this(dataCenterId, null, null, null, null, null);
@@ -124,4 +127,32 @@ public String toString() {
                 "migrationPlan");
     }
 
+    @Override
+    public void adjustHostPriority(Long hostId, HostPriorityAdjustment adjustment) {
+        Integer currentPriority = hostPriorities.get(hostId);
+        if (currentPriority == null) {
+            currentPriority = DEFAULT_HOST_PRIORITY;
+        } else if (currentPriority.equals(PROHIBITED_HOST_PRIORITY)) {
+            return;
+        }
+        if (HostPriorityAdjustment.HIGHER.equals(adjustment)) {
+            hostPriorities.put(hostId, currentPriority + ADJUST_HOST_PRIORITY_BY);
+        } else if (HostPriorityAdjustment.LOWER.equals(adjustment)) {
+            hostPriorities.put(hostId, currentPriority - ADJUST_HOST_PRIORITY_BY);
+        } else if (HostPriorityAdjustment.DEFAULT.equals(adjustment)) {
+            hostPriorities.put(hostId, DEFAULT_HOST_PRIORITY);
+        } else if (HostPriorityAdjustment.PROHIBIT.equals(adjustment)) {
+            hostPriorities.put(hostId, PROHIBITED_HOST_PRIORITY);
+        }
+    }
+
+    @Override
+    public Map<Long, Integer> getHostPriorities() {
+        return hostPriorities;
+    }
+
+    @Override
+    public void setHostPriorities(Map<Long, Integer> priorities) {
+        this.hostPriorities = priorities;
+    }
 }

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

@@ -20,10 +20,23 @@
 import com.cloud.vm.ReservationContext;
 
 import java.util.List;
+import java.util.Map;
 
 /**
  */
 public interface DeploymentPlan {
+
+    Integer DEFAULT_HOST_PRIORITY = 0;
+    Integer PROHIBITED_HOST_PRIORITY = Integer.MIN_VALUE;
+    Integer ADJUST_HOST_PRIORITY_BY = 1;
+
+    enum HostPriorityAdjustment {
+        HIGHER,
+        DEFAULT,
+        LOWER,
+        PROHIBIT
+    }
+
     // TODO: This interface is not fully developed. It really
     // number of parameters to be specified.
 
@@ -73,4 +86,10 @@ public interface DeploymentPlan {
     List<Long> getPreferredHosts();
 
     boolean isMigrationPlan();
+
+    void adjustHostPriority(Long hostId, HostPriorityAdjustment priority);
+
+    Map<Long, Integer> getHostPriorities();
+
+    void setHostPriorities(Map<Long, Integer> priorities);
 }

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

@@ -75,6 +75,7 @@ public static class Param {
         public static final Param BootType = new Param("BootType");
         public static final Param BootIntoSetup = new Param("enterHardwareSetup");
         public static final Param PreserveNics = new Param("PreserveNics");
+        public static final Param ConsiderLastHost = new Param("ConsiderLastHost");
 
         private String name;
 

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

@@ -634,6 +634,7 @@ public class ApiConstants {
     public static final String PURPOSE = "purpose";
     public static final String IS_TAGGED = "istagged";
     public static final String INSTANCE_NAME = "instancename";
+    public static final String CONSIDER_LAST_HOST = "considerlasthost";
     public static final String START_VM = "startvm";
     public static final String HA_HOST = "hahost";
     public static final String CUSTOM_DISK_OFF_MIN_SIZE = "customdiskofferingminsize";

api/src/main/java/org/apache/cloudstack/api/command/user/vm/StartVMCmd.java

@@ -82,6 +82,13 @@ public class StartVMCmd extends BaseAsyncCmd implements UserCmd {
                since = "3.0.1")
     private Long hostId;
 
+    @Parameter(name = ApiConstants.CONSIDER_LAST_HOST,
+            type = CommandType.BOOLEAN,
+            description = "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. " +
+                    "If false, CloudStack will not consider the last host and start the VM by normal process.",
+            since = "4.18.0")
+    private Boolean considerLastHost;
+
     @Parameter(name = ApiConstants.DEPLOYMENT_PLANNER, type = CommandType.STRING, description = "Deployment planner to use for vm allocation. Available to ROOT admin only", since = "4.4", authorized = { RoleType.Admin })
     private String deploymentPlanner;
 
@@ -112,6 +119,10 @@ public Boolean getBootIntoSetup() {
         return bootIntoSetup;
     }
 
+    public Boolean getConsiderLastHost() {
+        return considerLastHost;
+    }
+
     // ///////////////////////////////////////////////////
     // ///////////// API Implementation///////////////////
     // ///////////////////////////////////////////////////

api/src/test/java/com/cloud/deploy/DataCenterDeploymentTest.java

@@ -0,0 +1,57 @@
+/*
+ * 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.deploy;
+
+import junit.framework.TestCase;
+import org.junit.Assert;
+
+public class DataCenterDeploymentTest extends TestCase {
+
+    private long zoneId = 1L;
+    private long hostId = 2L;
+
+    DataCenterDeployment plan = new DataCenterDeployment(zoneId);
+
+    private void verifyHostPriority(Integer priority) {
+        Assert.assertEquals(priority, plan.getHostPriorities().get(hostId));
+    }
+
+    public void testHostPriorities() {
+        verifyHostPriority(null);
+
+        plan.adjustHostPriority(hostId, DeploymentPlan.HostPriorityAdjustment.DEFAULT);
+        verifyHostPriority(0);
+
+        plan.adjustHostPriority(hostId, DeploymentPlan.HostPriorityAdjustment.HIGHER);
+        verifyHostPriority(1);
+
+        plan.adjustHostPriority(hostId, DeploymentPlan.HostPriorityAdjustment.LOWER);
+        verifyHostPriority(0);
+
+        plan.adjustHostPriority(hostId, DeploymentPlan.HostPriorityAdjustment.LOWER);
+        verifyHostPriority(-1);
+
+        plan.adjustHostPriority(hostId, DeploymentPlan.HostPriorityAdjustment.HIGHER);
+        verifyHostPriority(0);
+
+        plan.adjustHostPriority(hostId, DeploymentPlan.HostPriorityAdjustment.HIGHER);
+        verifyHostPriority(1);
+    }
+}

client/pom.xml

@@ -478,6 +478,16 @@
             <artifactId>cloud-plugin-host-affinity</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.apache.cloudstack</groupId>
+            <artifactId>cloud-plugin-non-strict-host-anti-affinity</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.cloudstack</groupId>
+            <artifactId>cloud-plugin-non-strict-host-affinity</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.apache.cloudstack</groupId>
             <artifactId>cloud-plugin-api-solidfire-intg-test</artifactId>

core/src/main/resources/META-INF/cloudstack/core/spring-core-registry-core-context.xml

@@ -248,7 +248,7 @@
         class="org.apache.cloudstack.spring.lifecycle.registry.ExtensionRegistry">
         <property name="orderConfigKey" value="affinity.processors.order" />
         <property name="orderConfigDefault"
-            value="HostAntiAffinityProcessor,ExplicitDedicationProcessor,HostAffinityProcessor" />
+            value="HostAntiAffinityProcessor,ExplicitDedicationProcessor,HostAffinityProcessor,NonStrictHostAntiAffinityProcessor,NonStrictHostAffinityProcessor" />
         <property name="excludeKey" value="affinity.processors.exclude" />
     </bean>
 

engine/components-api/src/main/java/com/cloud/deploy/DeploymentPlanningManager.java

@@ -20,10 +20,14 @@
 import com.cloud.deploy.DeploymentPlanner.ExcludeList;
 import com.cloud.exception.AffinityConflictException;
 import com.cloud.exception.InsufficientServerCapacityException;
+import com.cloud.host.Host;
 import com.cloud.utils.component.Manager;
 import com.cloud.vm.VirtualMachineProfile;
 import org.apache.cloudstack.framework.config.ConfigKey;
 
+import java.util.List;
+import java.util.Map;
+
 public interface DeploymentPlanningManager extends Manager {
 
 
@@ -60,4 +64,6 @@ String finalizeReservation(DeployDestination plannedDestination,
     DeploymentPlanner getDeploymentPlannerByName(String plannerName);
 
     void checkForNonDedicatedResources(VirtualMachineProfile vmProfile, DataCenter dc, ExcludeList avoids);
+
+    void reorderHostsByPriority(Map<Long, Integer> priorities, List<Host> hosts);
 }

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

@@ -1412,6 +1412,10 @@ private void logBootModeParameters(Map<VirtualMachineProfile.Param, Object> para
             msgBuf.append(String.format("Boot into Setup: %s ", params.get(VirtualMachineProfile.Param.BootIntoSetup)));
             log = true;
         }
+        if (params.get(VirtualMachineProfile.Param.ConsiderLastHost) != null) {
+            msgBuf.append(String.format("Consider last host: %s ", params.get(VirtualMachineProfile.Param.ConsiderLastHost)));
+            log = true;
+        }
         if (log) {
             s_logger.info(msgBuf.toString());
         }