Add spotVM and maxRunDuration feature to VM provisioning

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

@@ -18,7 +18,10 @@
 
 import static com.google.cloud.graphite.platforms.plugin.client.util.ClientUtil.nameFromSelfLink;
 import static com.google.jenkins.plugins.computeengine.ComputeEngineCloud.checkPermissions;
+import static com.google.jenkins.plugins.computeengine.ui.helpers.ProvisioningTypeValue.PREEMPTIBLE;
+import static com.google.jenkins.plugins.computeengine.ui.helpers.ProvisioningTypeValue.SPOT;
 
+import com.google.api.client.json.GenericJson;
 import com.google.api.services.compute.model.AcceleratorConfig;
 import com.google.api.services.compute.model.AttachedDisk;
 import com.google.api.services.compute.model.AttachedDiskInitializeParams;
@@ -42,6 +45,8 @@
 import com.google.jenkins.plugins.computeengine.ssh.GoogleKeyCredential;
 import com.google.jenkins.plugins.computeengine.ssh.GoogleKeyPair;
 import com.google.jenkins.plugins.computeengine.ssh.GooglePrivateKey;
+import com.google.jenkins.plugins.computeengine.ui.helpers.ProvisioningType;
+import com.google.jenkins.plugins.computeengine.ui.helpers.ProvisioningTypeValue;
 import edu.umd.cs.findbugs.annotations.Nullable;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.Extension;
@@ -63,6 +68,7 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
 import java.util.logging.Level;
@@ -120,7 +126,19 @@
     private String machineType;
     private String numExecutorsStr;
     private String startupScript;
+
+    /**
+     * Use the {@link #provisioningType} field instead.
+     */
+    @Deprecated
     private boolean preemptible;
+
+    /**
+     * Succeeds {@link #preemptible}.
+     */
+    private ProvisioningType provisioningType;
+
+    private long maxRunDurationSeconds;
     private String minCpuPlatform;
     private String labels;
     private String runAsUser;
@@ -494,7 +512,26 @@
 
     private Scheduling scheduling() {
         Scheduling scheduling = new Scheduling();
-        scheduling.setPreemptible(preemptible);
+
+        if (provisioningType != null) {
+            if (provisioningType.getValue() == PREEMPTIBLE) {
+                scheduling.setPreemptible(true);
+            } else if (provisioningType.getValue() == SPOT) {
+                scheduling.setProvisioningModel("SPOT");
+                // only the instance is deleted, the disk deletion is based on bootDiskAutoDelete config value
+                scheduling.setInstanceTerminationAction("DELETE");
+            }
+        } else if (preemptible) { // keeping the check for `preemptible` for backward compatibility
+            scheduling.setPreemptible(true);
+        } // else: standard provisioning
+
+        if (maxRunDurationSeconds > 0 && provisioningType.getValue() != PREEMPTIBLE) {
+            GenericJson j = new GenericJson();
+            j.set("seconds", maxRunDurationSeconds);
+            scheduling.set("maxRunDuration", j);
+            // only the instance is deleted, the disk deletion is based on bootDiskAutoDelete config value
+            scheduling.setInstanceTerminationAction("DELETE");
+        }
         return scheduling;
     }
 
@@ -554,6 +591,7 @@
     @Extension
     public static final class DescriptorImpl extends Descriptor<InstanceConfiguration> {
         private static ComputeClient computeClient;
+        private static List<ProvisioningType.ProvisioningTypeDescriptor> provisioningTypeDescriptors;
 
         public static void setComputeClient(ComputeClient client) {
             computeClient = client;
@@ -783,6 +821,29 @@
             return FormValidation.ok();
         }
 
+        public FormValidation doCheckMaxRunDurationSeconds(
+                @QueryParameter String value, @QueryParameter(value="provisioningType") String provisioningTypeIdx) {
+            try {
+                long maxRunDurationSeconds = Long.parseLong(value);
+                if (maxRunDurationSeconds < 0) {
+                    return FormValidation.error("Max run duration must be greater than or equal to 0");
+                }
+
+                if (StringUtils.isNotBlank(provisioningTypeIdx)) {
+                    ProvisioningTypeValue provisioningTypeValue = provisioningTypeDescriptors
+                            .get(Integer.parseInt(provisioningTypeIdx))
+                            .getProvisioningTypeValue();
+                    if (provisioningTypeValue == PREEMPTIBLE) {
+                        return FormValidation.warning("Max run duration is not supported for preemptible VMs and will be ignored.");
+                    }
+                }
+
+                return FormValidation.ok();
+            } catch (NumberFormatException e) {
+                return FormValidation.error("Max run duration must be non-negative number");
+            }
+        }
+
         public ListBoxModel doFillMinCpuPlatformItems(
                 @AncestorInPath Jenkins context,
                 @QueryParameter("projectId") @RelativePath("..") final String projectId,
@@ -943,6 +1004,15 @@
             return FormValidation.ok();
         }
 
+        @SuppressWarnings("unused")
+        public List<ProvisioningType.ProvisioningTypeDescriptor> getProvisioningTypes() {
+            if (provisioningTypeDescriptors == null) {
+                provisioningTypeDescriptors =
+                        Objects.requireNonNull(Jenkins.getInstanceOrNull()).getDescriptorList(ProvisioningType.class);
+            }
+            return provisioningTypeDescriptors;
+        }
+
         public List<NetworkInterfaceIpStackMode.Descriptor> getNetworkInterfaceIpStackModeDescriptors() {
             return ExtensionList.lookup(NetworkInterfaceIpStackMode.Descriptor.class);
         }
@@ -959,6 +1029,8 @@
             instanceConfiguration.setNumExecutorsStr(this.numExecutorsStr);
             instanceConfiguration.setStartupScript(this.startupScript);
             instanceConfiguration.setPreemptible(this.preemptible);
+            instanceConfiguration.setProvisioningType(this.provisioningType);
+            instanceConfiguration.setMaxRunDurationSeconds(this.maxRunDurationSeconds);
             instanceConfiguration.setMinCpuPlatform(this.minCpuPlatform);
             instanceConfiguration.setLabelString(this.labels);
             instanceConfiguration.setRunAsUser(this.runAsUser);

src/main/java/com/google/jenkins/plugins/computeengine/ui/helpers/PreemptibleVm.java

@@ -0,0 +1,27 @@
+package com.google.jenkins.plugins.computeengine.ui.helpers;
+
+import hudson.Extension;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+
+@SuppressWarnings("unused")
+public class PreemptibleVm extends ProvisioningType {
+
+    @DataBoundConstructor
+    public PreemptibleVm() {
+        super(ProvisioningTypeValue.PREEMPTIBLE);
+    }
+
+    @Extension
+    public static class DescriptorImpl extends ProvisioningTypeDescriptor {
+        @Override
+        public String getDisplayName() {
+            return "Preemptible VM";
+        }
+
+        @Override
+        public ProvisioningTypeValue getProvisioningTypeValue() {
+            return ProvisioningTypeValue.PREEMPTIBLE;
+        }
+    }
+}

src/main/java/com/google/jenkins/plugins/computeengine/ui/helpers/ProvisioningType.java

@@ -0,0 +1,30 @@
+package com.google.jenkins.plugins.computeengine.ui.helpers;
+
+import org.kohsuke.stapler.DataBoundSetter;
+
+import hudson.model.AbstractDescribableImpl;
+import hudson.model.Descriptor;
+
+/**
+ * ProvisioningType represents the type of VM to be provisioned.
+ */
+public abstract class ProvisioningType extends AbstractDescribableImpl<ProvisioningType> {
+    public ProvisioningTypeValue value;
+
+    public ProvisioningType(ProvisioningTypeValue value) {
+        this.value = value;
+    }
+
+    public ProvisioningTypeValue getValue() {
+        return value;
+    }
+
+    @DataBoundSetter
+    public void setProvisioningTypeValue(ProvisioningTypeValue value) {
+        this.value = value;
+    }
+
+    public abstract static class ProvisioningTypeDescriptor extends Descriptor<ProvisioningType> {
+        public abstract ProvisioningTypeValue getProvisioningTypeValue();
+    }
+}

src/main/java/com/google/jenkins/plugins/computeengine/ui/helpers/ProvisioningTypeValue.java

@@ -0,0 +1,7 @@
+package com.google.jenkins.plugins.computeengine.ui.helpers;
+
+public enum ProvisioningTypeValue {
+    STANDARD,
+    SPOT,
+    PREEMPTIBLE;
+}

src/main/java/com/google/jenkins/plugins/computeengine/ui/helpers/SpotVm.java

@@ -0,0 +1,27 @@
+package com.google.jenkins.plugins.computeengine.ui.helpers;
+
+import hudson.Extension;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+
+@SuppressWarnings("unused")
+public class SpotVm extends ProvisioningType {
+
+    @DataBoundConstructor
+    public SpotVm() {
+        super(ProvisioningTypeValue.SPOT);
+    }
+
+    @Extension
+    public static class DescriptorImpl extends ProvisioningTypeDescriptor {
+        @Override
+        public String getDisplayName() {
+            return "Spot VM";
+        }
+
+        @Override
+        public ProvisioningTypeValue getProvisioningTypeValue() {
+            return ProvisioningTypeValue.SPOT;
+        }
+    }
+}

src/main/java/com/google/jenkins/plugins/computeengine/ui/helpers/Standard.java

@@ -0,0 +1,27 @@
+package com.google.jenkins.plugins.computeengine.ui.helpers;
+
+import hudson.Extension;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
+
+@SuppressWarnings("unused")
+public class Standard extends ProvisioningType {
+
+    @DataBoundConstructor
+    public Standard() {
+        super(ProvisioningTypeValue.STANDARD);
+    }
+
+    @Extension
+    public static class DescriptorImpl extends ProvisioningTypeDescriptor {
+        @Override
+        public String getDisplayName() {
+            return "Standard";
+        }
+
+        @Override
+        public ProvisioningTypeValue getProvisioningTypeValue() {
+            return ProvisioningTypeValue.STANDARD;
+        }
+    }
+}

src/main/resources/com/google/jenkins/plugins/computeengine/InstanceConfiguration/config.jelly

@@ -89,8 +89,12 @@
                 <f:entry field="machineType" title="${%Machine Type}">
                     <f:select/>
                 </f:entry>
-                <f:entry field="preemptible" title="${%Preemptible?}">
-                    <f:checkbox/>
+                <f:descriptorRadioList descriptors="${descriptor.provisioningTypes}"
+                                       title="Provisioning Type"
+                                       instance="${instance}"
+                                       varName="provisioningType"/>
+                <f:entry field="maxRunDurationSeconds" title="${%Max Run Duration Seconds}">
+                    <f:textbox/>
                 </f:entry>
                 <f:entry field="minCpuPlatform" title="${%Minimum Cpu Platform}">
                     <f:select/>

src/main/resources/com/google/jenkins/plugins/computeengine/InstanceConfiguration/help-maxRunDurationSeconds.html

@@ -0,0 +1,19 @@
+<!--
+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
+
+        https://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.
+-->
+<div>
+    The maximum duration (in seconds) after which the VM will be automatically deleted by GCP.
+    See <a href="https://cloud.google.com/compute/docs/instances/limit-vm-runtime">Limit the run time of a VM</a> for more details.
+</div>

src/main/resources/com/google/jenkins/plugins/computeengine/InstanceConfiguration/help-provisioningType.html

@@ -0,0 +1,41 @@
+<!--
+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
+
+        https://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.
+-->
+
+<div>
+    GCP offers three VM provisioning options, each with different availability, pricing, and termination policies.
+    The "<code>Max Run Duration Seconds</code>" field below applies to all three types.
+    <ul>
+        <li>
+            <strong>Standard:</strong> Stable provisioning model with guaranteed availability by GCP SLAs.
+            Higher pricing compared to Spot and Preemptible VMs.
+        </li>
+        <li>
+            <strong>Spot:</strong> Low-cost instances that may be terminated if resources are needed elsewhere. Availability varies.
+            Unlike Preemptible VMs, they are not always terminated after 24 hours. Spot and Preemptible VMs are priced the same.
+            Set the "<code>Max Run Duration Seconds</code>" field below to ensure termination after a specific duration.
+            <p>
+                See <a href="https://cloud.google.com/compute/docs/instances/spot">Spot VMs</a> for more details.
+            </p>
+        </li>
+        <li>
+            <strong>Preemptible:</strong> Low-cost instances that may be terminated if resources are needed for other tasks.
+            Availability varies with usage. Spot and Preemptible VMs are priced the same.
+            <p>
+                See the <a href="https://cloud.google.com/compute/docs/instances/preemptible">Preemptible VM Instances</a> documentation for more information.
+            </p>
+        </li>
+    </ul>
+</div>