Per template max agent (#338)

Author: timja

src/main/java/com/microsoft/azure/vmagent/AzureVMAgent.java

@@ -661,7 +661,7 @@ public synchronized void deprovision(Localizable reason) throws Exception {
         // Adjust estimated virtual machine count.
         AzureVMCloud parentCloud = getCloud();
         if (parentCloud != null) {
-            parentCloud.adjustVirtualMachineCount(-1);
+            parentCloud.adjustVirtualMachineCount(-1, template.getMaxVirtualMachinesLimit());
         }
 
         Jenkins.get().removeNode(this);

src/main/java/com/microsoft/azure/vmagent/AzureVMAgentTemplate.java

@@ -352,6 +352,8 @@ public int hashCode() {
 
     private List<AzureTagPair> tags;
 
+    private int maxVirtualMachinesLimit;
+
     // deprecated fields
     private transient boolean isInstallDocker;
     private transient boolean isInstallMaven;
@@ -560,6 +562,15 @@ public String getAvailabilitySet() {
         return availabilityType != null ? availabilityType.getAvailabilitySet() : null;
     }
 
+    public int getMaxVirtualMachinesLimit() {
+        return maxVirtualMachinesLimit;
+    }
+
+    @DataBoundSetter
+    public void setMaxVirtualMachinesLimit(int maxVirtualMachinesLimit) {
+        this.maxVirtualMachinesLimit = maxVirtualMachinesLimit;
+    }
+
     public String getJavaPath() {
         return javaPath;
     }

src/main/java/com/microsoft/azure/vmagent/AzureVMCloud.java

@@ -375,9 +375,10 @@ public int getApproximateVirtualMachineCount() {
      * of virtual machines we currently have available.
      *
      * @param delta Number that are desired, or if less than 0, the number we are 'returning' to the pool
+     * @param templateLimit max agents for the template in use
      * @return Number that can be allocated, up to the number desired.  0 if the number desired was < 0
      */
-    public int adjustVirtualMachineCount(int delta) {
+    public int adjustVirtualMachineCount(int delta, int templateLimit) {
         synchronized (this) {
             if (delta < 0) {
                 LOGGER.log(Level.FINE, "Current estimated VM count: {0}, reducing by {1}",
@@ -387,7 +388,8 @@ public int adjustVirtualMachineCount(int delta) {
             } else {
                 LOGGER.log(Level.FINE, "Current estimated VM count: {0}, quantity desired {1}",
                         new Object[]{approximateVirtualMachineCount, delta});
-                if (approximateVirtualMachineCount + delta <= getMaxVirtualMachinesLimit()) {
+                int limit = determineLimit(templateLimit);
+                if (approximateVirtualMachineCount + delta <= limit) {
                     // Enough available, return the desired quantity, and update the number we think we
                     // have laying around.
                     approximateVirtualMachineCount += delta;
@@ -396,14 +398,25 @@ public int adjustVirtualMachineCount(int delta) {
                     // Not enough available, return what we have. Remember we could
                     // go negative (if for instance another Jenkins instance had
                     // a higher limit.
-                    int quantityAvailable = Math.max(0, getMaxVirtualMachinesLimit() - approximateVirtualMachineCount);
+                    int quantityAvailable = Math.max(0, limit - approximateVirtualMachineCount);
                     approximateVirtualMachineCount += quantityAvailable;
                     return quantityAvailable;
                 }
             }
         }
     }
 
+    private int determineLimit(int templateLimit) {
+        int cloudLimit = getMaxVirtualMachinesLimit();
+        if (templateLimit > cloudLimit) {
+            return cloudLimit;
+        }
+        if (templateLimit == 0) {
+            return cloudLimit;
+        }
+        return templateLimit;
+    }
+
     /**
      * Sets the new approximate virtual machine count.
      * This is run by the verification task to update the VM count periodically.
@@ -670,11 +683,12 @@ public Collection<PlannedNode> provision(CloudState cloudState, int workLoad) {
             try {
                 // Determine how many agents we can actually provision from here and
                 // adjust our count (before deployment to avoid races)
-                int adjustedNumberOfAgents = adjustVirtualMachineCount(numberOfAgents);
+                int adjustedNumberOfAgents = adjustVirtualMachineCount(numberOfAgents,
+                        template.getMaxVirtualMachinesLimit());
                 if (adjustedNumberOfAgents == 0) {
                     LOGGER.log(Level.INFO,
                             "Not able to create {0} nodes, at or above maximum VM count of {1} and already {2} VM(s)",
-                            new Object[]{numberOfAgents, getMaxVirtualMachinesLimit(),
+                            new Object[]{numberOfAgents, determineLimit(template.getMaxVirtualMachinesLimit()),
                                 getApproximateVirtualMachineCount()});
                     return plannedNodes;
                 } else if (adjustedNumberOfAgents < numberOfAgents) {
@@ -844,7 +858,8 @@ private void handleFailure(
                                     // Do not throw to avoid it being recorded
                                 }
                             }
-                            template.retrieveAzureCloudReference().adjustVirtualMachineCount(-1);
+                            template.retrieveAzureCloudReference().adjustVirtualMachineCount(-1,
+                                    template.getMaxVirtualMachinesLimit());
                             // Update the template status given this new issue.
                             template.handleTemplateProvisioningFailure(e.getMessage(), stage);
                         }

src/main/resources/com/microsoft/azure/vmagent/AzureVMAgentTemplate/config.jelly

@@ -13,6 +13,11 @@
                 <f:textbox/>
             </f:entry>
 
+            <f:entry title="${%Max_Virtual_Machines_Limit}" field="maxVirtualMachinesLimit"
+                     help="/plugin/azure-vm-agents/help-maxVirtualMachinesLimit.html">
+                <f:number />
+            </f:entry>
+
             <f:entry title="${%Custom_Tag}" field="tags">
                 <f:repeatableProperty field="tags">
                     <f:entry>

src/main/resources/com/microsoft/azure/vmagent/AzureVMAgentTemplate/config.properties

@@ -1,6 +1,7 @@
 General_Configuration=General Configuration
 Template_Name=Name
 Template_Description=Description
+Max_Virtual_Machines_Limit=Max Jenkins Agents Limit
 Labels=Labels
 Location=Region
 No_Availability=No infrastructure redundancy required

src/main/resources/com/microsoft/azure/vmagent/AzureVMCloud/config.jelly

@@ -15,7 +15,7 @@
         </f:entry>
         <f:entry title="${%Max_Virtual_Machines_Limit}" field="maxVirtualMachinesLimit"
                  help="/plugin/azure-vm-agents/help-maxVirtualMachinesLimit.html">
-            <f:textbox default="${descriptor.getDefaultMaxVMLimit()}"/>
+            <f:number default="${descriptor.defaultMaxVMLimit}"/>
         </f:entry>
 
         <f:entry title="${%Deployment_Timeout}" field="deploymentTimeout"

src/main/webapp/help-maxVirtualMachinesLimit.html

@@ -1,6 +1,3 @@
 <div>
     Specify the maximum number of virtual machines that can be created.<br>
-
-    <b>This number only includes those VMs in the specified resource group</b>
-
 </div>