Merge pull request #492 from gbhat618/add-max-run-duration-to-vm-provisioning

Add spotVM and maxRunDuration feature to VM provisioning

Author: raul-arabaolaza

src/main/java/com/google/jenkins/plugins/computeengine/InstanceConfiguration.java

@@ -37,8 +37,12 @@
 import com.google.api.services.compute.model.Zone;
 import com.google.cloud.graphite.platforms.plugin.client.ClientFactory;
 import com.google.cloud.graphite.platforms.plugin.client.ComputeClient;
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Strings;
 import com.google.jenkins.plugins.computeengine.client.ClientUtil;
+import com.google.jenkins.plugins.computeengine.config.PreemptibleVm;
+import com.google.jenkins.plugins.computeengine.config.ProvisioningType;
+import com.google.jenkins.plugins.computeengine.config.Standard;
 import com.google.jenkins.plugins.computeengine.ssh.GoogleKeyCredential;
 import com.google.jenkins.plugins.computeengine.ssh.GoogleKeyPair;
 import com.google.jenkins.plugins.computeengine.ssh.GooglePrivateKey;
@@ -117,7 +121,7 @@ public class InstanceConfiguration implements Describable<InstanceConfiguration>
     private String machineType;
     private String numExecutorsStr;
     private String startupScript;
-    private boolean preemptible;
+    private ProvisioningType provisioningType;
     private String minCpuPlatform;
     private String labels;
     private String runAsUser;
@@ -164,6 +168,11 @@ public class InstanceConfiguration implements Describable<InstanceConfiguration>
     @Setter(AccessLevel.PROTECTED)
     protected transient ComputeEngineCloud cloud;
 
+    /** @deprecated Use {@link #provisioningType} instead. */
+    @SuppressWarnings("DeprecatedIsStillUsed")
+    @Deprecated
+    private transient boolean preemptible;
+
     private static List<Metadata.Items> mergeMetadataItems(List<Metadata.Items> winner, List<Metadata.Items> loser) {
         if (loser == null) {
             loser = new ArrayList<Metadata.Items>();
@@ -233,6 +242,24 @@ public void setCreateSnapshot(boolean createSnapshot) {
         this.createSnapshot = createSnapshot && this.oneShot;
     }
 
+    /**
+     * This setter is kept only to provide JCasC compatibility, don't use for any other.
+     * Although JCasC is not "required" to keep compatibility, but in this case,
+     * as it is very low effort to keep the compatibility, we have decided to keep it.
+     * <p>
+     * Previously, JCasC syntax would be {@code preemptible: true}, going forward instead should be done as,
+     * {@code provisioningType: preemptibleVm}
+     * <p>
+     * Currently only caller is, JCasC configurators if the bundle is having `preemptible` field defined in it.
+     * Consider deleting it in future (perhaps after a year or so)
+     */
+    @DataBoundSetter
+    public void setPreemptible(boolean preemptible) {
+        if (preemptible) {
+            this.provisioningType = new PreemptibleVm();
+        }
+    }
+
     public static Integer intOrDefault(String toParse, Integer defaultTo) {
         Integer toReturn;
         try {
@@ -354,6 +381,10 @@ protected Object readResolve() {
             this.networkInterfaceIpStackMode = new NetworkInterfaceSingleStack(externalAddress);
             this.externalAddress = null;
         }
+        /* deprecating `preemptible` in favor of extensible `provisioningType` */
+        if (preemptible && provisioningType == null) {
+            provisioningType = new PreemptibleVm();
+        }
         return this;
     }
 
@@ -489,9 +520,13 @@ private Tags tags() {
         return null;
     }
 
-    private Scheduling scheduling() {
+    @VisibleForTesting
+    Scheduling scheduling() {
         Scheduling scheduling = new Scheduling();
-        scheduling.setPreemptible(preemptible);
+        if (provisioningType == null) {
+            return scheduling;
+        }
+        provisioningType.configure(scheduling);
         return scheduling;
     }
 
@@ -587,6 +622,11 @@ public static SshConfiguration defaultSshConfiguration() {
             return SshConfiguration.builder().customPrivateKeyCredentialsId("").build();
         }
 
+        @SuppressWarnings("unused") // jelly
+        public ProvisioningType defaultProvisioningType() {
+            return new Standard(0);
+        }
+
         public static NetworkConfiguration defaultNetworkConfiguration() {
             return new AutofilledNetworkConfiguration();
         }
@@ -936,6 +976,11 @@ public FormValidation doCheckNumExecutorsStr(
             return FormValidation.ok();
         }
 
+        @SuppressWarnings("unused") // jelly
+        public List<ProvisioningType.ProvisioningTypeDescriptor> getProvisioningTypes() {
+            return ExtensionList.lookup(ProvisioningType.ProvisioningTypeDescriptor.class);
+        }
+
         public List<NetworkInterfaceIpStackMode.Descriptor> getNetworkInterfaceIpStackModeDescriptors() {
             return ExtensionList.lookup(NetworkInterfaceIpStackMode.Descriptor.class);
         }
@@ -951,7 +996,7 @@ public InstanceConfiguration build() {
             instanceConfiguration.setMachineType(this.machineType);
             instanceConfiguration.setNumExecutorsStr(this.numExecutorsStr);
             instanceConfiguration.setStartupScript(this.startupScript);
-            instanceConfiguration.setPreemptible(this.preemptible);
+            instanceConfiguration.setProvisioningType(this.provisioningType);
             instanceConfiguration.setMinCpuPlatform(this.minCpuPlatform);
             instanceConfiguration.setLabelString(this.labels);
             instanceConfiguration.setRunAsUser(this.runAsUser);

src/main/java/com/google/jenkins/plugins/computeengine/config/PreemptibleVm.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2024 CloudBees, Inc.
+ *
+ * Licensed 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.google.jenkins.plugins.computeengine.config;
+
+import com.google.api.services.compute.model.Scheduling;
+import hudson.Extension;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+public class PreemptibleVm extends ProvisioningType {
+
+    @DataBoundConstructor
+    public PreemptibleVm() {}
+
+    @Override
+    public void configure(Scheduling scheduling) {
+        scheduling.setPreemptible(true);
+    }
+
+    @Extension
+    public static class DescriptorImpl extends ProvisioningTypeDescriptor {
+        @Override
+        public String getDisplayName() {
+            return "Preemptible VM";
+        }
+
+        @Override
+        public boolean isMaxRunDurationSupported() {
+            return false;
+        }
+    }
+}

src/main/java/com/google/jenkins/plugins/computeengine/config/ProvisioningType.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2024 CloudBees, Inc.
+ *
+ * Licensed 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.google.jenkins.plugins.computeengine.config;
+
+import com.google.api.client.json.GenericJson;
+import com.google.api.services.compute.model.Scheduling;
+import hudson.model.AbstractDescribableImpl;
+import hudson.model.Descriptor;
+
+/**
+ * ProvisioningType represents the type of VM to be provisioned.
+ */
+public abstract class ProvisioningType extends AbstractDescribableImpl<ProvisioningType> {
+
+    protected void configureMaxRunDuration(Scheduling scheduling, long maxRunDurationSeconds) {
+        if (maxRunDurationSeconds > 0) {
+            GenericJson j = new GenericJson();
+            j.set("seconds", maxRunDurationSeconds);
+            scheduling.set("maxRunDuration", j);
+            /* Note: Only the instance is set to delete here, not the disk. Disk deletion is based on the
+              `bootDiskAutoDelete` config value. For instance termination at `maxRunDuration`, GCP supports two
+              termination actions: DELETE and STOP.
+              For Jenkins agents, DELETE is more appropriate. If the agent instance is needed again, it can be
+              recreated using the disk, which should have been anticipated and disk should be set to not delete in
+              `bootDiskAutoDelete`.
+            */
+            scheduling.setInstanceTerminationAction("DELETE");
+        }
+    }
+
+    public abstract void configure(Scheduling scheduling);
+
+    public abstract static class ProvisioningTypeDescriptor extends Descriptor<ProvisioningType> {
+
+        @SuppressWarnings("unused") // jelly
+        public abstract boolean isMaxRunDurationSupported();
+    }
+}

src/main/java/com/google/jenkins/plugins/computeengine/config/SpotVm.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2024 CloudBees, Inc.
+ *
+ * Licensed 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.google.jenkins.plugins.computeengine.config;
+
+import com.google.api.services.compute.model.Scheduling;
+import hudson.Extension;
+import hudson.util.FormValidation;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+import org.kohsuke.stapler.QueryParameter;
+
+public class SpotVm extends ProvisioningType {
+
+    private long maxRunDurationSeconds;
+
+    // required for casc
+    @DataBoundConstructor
+    public SpotVm(long maxRunDurationSeconds) {
+        this.maxRunDurationSeconds = maxRunDurationSeconds;
+    }
+
+    @SuppressWarnings("unused") // jelly
+    @DataBoundSetter
+    public void setMaxRunDurationSeconds(long maxRunDurationSeconds) {
+        this.maxRunDurationSeconds = maxRunDurationSeconds;
+    }
+
+    @SuppressWarnings("unused") // jelly
+    public long getMaxRunDurationSeconds() {
+        return maxRunDurationSeconds;
+    }
+
+    @Override
+    public void configure(Scheduling scheduling) {
+        scheduling.setProvisioningModel("SPOT");
+        super.configureMaxRunDuration(scheduling, maxRunDurationSeconds);
+    }
+
+    @Extension
+    public static class DescriptorImpl extends ProvisioningTypeDescriptor {
+        @Override
+        public String getDisplayName() {
+            return "Spot VM";
+        }
+
+        @SuppressWarnings("unused") // jelly
+        public FormValidation doCheckMaxRunDurationSeconds(@QueryParameter String value) {
+            return Utils.doCheckMaxRunDurationSeconds(value);
+        }
+
+        @Override
+        public boolean isMaxRunDurationSupported() {
+            return true;
+        }
+    }
+}

src/main/java/com/google/jenkins/plugins/computeengine/config/Standard.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2024 CloudBees, Inc.
+ *
+ * Licensed 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.google.jenkins.plugins.computeengine.config;
+
+import com.google.api.services.compute.model.Scheduling;
+import hudson.Extension;
+import hudson.util.FormValidation;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+import org.kohsuke.stapler.QueryParameter;
+
+public class Standard extends ProvisioningType {
+
+    private long maxRunDurationSeconds;
+
+    // required for casc
+    @DataBoundConstructor
+    public Standard(long maxRunDurationSeconds) {
+        this.maxRunDurationSeconds = maxRunDurationSeconds;
+    }
+
+    @SuppressWarnings("unused") // jelly
+    @DataBoundSetter
+    public void setMaxRunDurationSeconds(long maxRunDurationSeconds) {
+        this.maxRunDurationSeconds = maxRunDurationSeconds;
+    }
+
+    @SuppressWarnings("unused") // jelly
+    public long getMaxRunDurationSeconds() {
+        return maxRunDurationSeconds;
+    }
+
+    @Override
+    public void configure(Scheduling scheduling) {
+        super.configureMaxRunDuration(scheduling, maxRunDurationSeconds);
+    }
+
+    @Extension
+    public static class DescriptorImpl extends ProvisioningTypeDescriptor {
+        @Override
+        public String getDisplayName() {
+            return "Standard";
+        }
+
+        @SuppressWarnings("unused") // jelly
+        public FormValidation doCheckMaxRunDurationSeconds(@QueryParameter String value) {
+            return Utils.doCheckMaxRunDurationSeconds(value);
+        }
+
+        @Override
+        public boolean isMaxRunDurationSupported() {
+            return true;
+        }
+    }
+}

src/main/java/com/google/jenkins/plugins/computeengine/config/Utils.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2024 CloudBees, Inc.
+ *
+ * Licensed 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.google.jenkins.plugins.computeengine.config;
+
+import hudson.util.FormValidation;
+import org.kohsuke.stapler.QueryParameter;
+
+class Utils {
+
+    static FormValidation doCheckMaxRunDurationSeconds(@QueryParameter String value) {
+        try {
+            long maxRunDurationSeconds = Long.parseLong(value);
+            if (maxRunDurationSeconds < 0) {
+                return FormValidation.error("Max run duration must be greater than or equal to 0");
+            }
+            return FormValidation.ok();
+        } catch (NumberFormatException e) {
+            return FormValidation.error("Max run duration must be non-negative number");
+        }
+    }
+}