Add ability to limit the size of ephemeral workspace volume (#1686)

Co-authored-by: Robert Fleischmann <[email protected]>
Co-authored-by: Vincent Latombe <[email protected]>

Author: 3 people

src/main/java/org/csanchez/jenkins/plugins/kubernetes/volumes/workspace/EmptyDirWorkspaceVolume.java

@@ -28,12 +28,15 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.Extension;
+import hudson.Util;
 import hudson.model.Descriptor;
+import io.fabric8.kubernetes.api.model.Quantity;
 import io.fabric8.kubernetes.api.model.Volume;
 import io.fabric8.kubernetes.api.model.VolumeBuilder;
 import java.util.Objects;
 import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
 
 @SuppressFBWarnings(
         value = "SE_NO_SERIALVERSIONID",
@@ -46,6 +49,9 @@ public class EmptyDirWorkspaceVolume extends WorkspaceVolume {
     @CheckForNull
     private Boolean memory;
 
+    @CheckForNull
+    private String sizeLimit;
+
     @DataBoundConstructor
     public EmptyDirWorkspaceVolume(Boolean memory) {
         this.memory = memory;
@@ -60,32 +66,49 @@ public Boolean getMemory() {
         return memory != null && memory;
     }
 
+    @CheckForNull
+    public String getSizeLimit() {
+        return sizeLimit;
+    }
+
+    @DataBoundSetter
+    public void setSizeLimit(@CheckForNull String sizeLimit) {
+        this.sizeLimit = Util.fixEmptyAndTrim(sizeLimit);
+    }
+
     @Override
     public Volume buildVolume(String volumeName, String podName) {
         return new VolumeBuilder()
                 .withName(volumeName)
                 .withNewEmptyDir()
                 .withMedium(getMedium())
+                .withSizeLimit(getSizeLimitAsQuantity())
                 .endEmptyDir()
                 .build();
     }
 
+    @CheckForNull
+    private Quantity getSizeLimitAsQuantity() {
+        var sizeLimit = getSizeLimit();
+        return sizeLimit == null ? null : new Quantity(sizeLimit);
+    }
+
     @Override
     public String toString() {
-        return "EmptyDirWorkspaceVolume [memory=" + memory + "]";
+        return "EmptyDirWorkspaceVolume [memory=" + memory + ", sizeLimit=" + sizeLimit + "]";
     }
 
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
         EmptyDirWorkspaceVolume that = (EmptyDirWorkspaceVolume) o;
-        return Objects.equals(memory, that.memory);
+        return Objects.equals(memory, that.memory) && Objects.equals(sizeLimit, that.sizeLimit);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(memory);
+        return Objects.hash(memory, sizeLimit);
     }
 
     @Extension

src/main/resources/org/csanchez/jenkins/plugins/kubernetes/volumes/workspace/EmptyDirWorkspaceVolume/config.jelly

@@ -2,8 +2,12 @@
 <j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout"
          xmlns:t="/lib/hudson" xmlns:f="/lib/form">
 
+  <f:entry title="${%Size Limit}" field="sizeLimit">
+    <f:textbox />
+  </f:entry>
+
   <f:entry title="${%In Memory}" field="memory">
     <f:checkbox />
   </f:entry>
 
-</j:jelly>
+</j:jelly>

src/main/resources/org/csanchez/jenkins/plugins/kubernetes/volumes/workspace/EmptyDirWorkspaceVolume/help-sizeLimit.html

@@ -0,0 +1 @@
+Sets a size limit. If the workspace size exceeds the specified size, the pod will be evicted. See <a href="https://kubernetes.io/docs/concepts/storage/volumes/#emptydir">details</a>.

src/test/java/org/csanchez/jenkins/plugins/kubernetes/PodTemplateBuilderTest.java

@@ -298,7 +298,9 @@ public void testValidateDockerRegistryPrefixOverrideForInitContainer(boolean dir
     @Issue("JENKINS-50525")
     public void testBuildWithCustomWorkspaceVolume() throws Exception {
         PodTemplate template = new PodTemplate();
-        template.setWorkspaceVolume(new EmptyDirWorkspaceVolume(true));
+        var workspaceVolume = new EmptyDirWorkspaceVolume(true);
+        workspaceVolume.setSizeLimit("1Gi");
+        template.setWorkspaceVolume(workspaceVolume);
         ContainerTemplate containerTemplate = new ContainerTemplate("name", "image");
         containerTemplate.setWorkingDir("");
         template.getContainers().add(containerTemplate);
@@ -317,7 +319,9 @@ public void testBuildWithCustomWorkspaceVolume() throws Exception {
 
         assertEquals(volumeMounts, container0.getVolumeMounts());
         assertEquals(volumeMounts, container1.getVolumeMounts());
-        assertEquals("Memory", pod.getSpec().getVolumes().get(0).getEmptyDir().getMedium());
+        var emptyDirVolumeSource = pod.getSpec().getVolumes().get(0).getEmptyDir();
+        assertEquals("Memory", emptyDirVolumeSource.getMedium());
+        assertThat(emptyDirVolumeSource.getSizeLimit(), is(new Quantity("1Gi")));
     }
 
     @Test