Skip to content

The Unified and Autonomous Development Platform

fix: Kubernetes cache not working for relative paths

Robin Shen06bd02cc37ec
diff --git a/pom.xml b/pom.xml
index 54eef51ef0..edb60279f4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -631,7 +631,7 @@
</repositories>
<properties>
<commons.version>2.8.3</commons.version>
- <agent.version>1.10.4</agent.version>
+ <agent.version>1.10.5</agent.version>
<slf4j.version>2.0.9</slf4j.version>
<logback.version>1.4.14</logback.version>
<antlr.version>4.7.2</antlr.version>
diff --git a/server-core/src/main/java/io/onedev/server/buildspec/step/GenerateChecksumStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/GenerateChecksumStep.java
index 5c38f0cbc3..53227393d6 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/GenerateChecksumStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/GenerateChecksumStep.java
@@ -80,6 +80,7 @@ public class GenerateChecksumStep extends CommandStep {
commands.add("set -e");
commands.add("shopt -s globstar");
commands.add("cat `ls -1 " + files + " 2>/dev/null` | md5sum | awk '{ print $1 }' > " + targetFile);
+ commands.add("echo Generated checksum: `cat " + targetFile + "`");
return commands;
}
};
diff --git a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
index 1efc605e74..7c23ff84a5 100644
--- a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
+++ b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java
@@ -6174,5 +6174,28 @@ public class DataMigrator {
}
}
}
+
+ // Migrate to 10.1.0
+ private void migrate155(File dataDir, Stack<Integer> versions) {
+ for (File file : dataDir.listFiles()) {
+ if (file.getName().startsWith("Settings.xml")) {
+ VersionedXmlDoc dom = VersionedXmlDoc.fromFile(file);
+ for (Element element : dom.getRootElement().elements()) {
+ String key = element.elementTextTrim("key");
+ if (key.equals("JOB_EXECUTORS")) {
+ Element valueElement = element.element("value");
+ if (valueElement != null) {
+ for (Element executorElement : valueElement.elements()) {
+ executorElement.element("cacheTTL").detach();
+ if (executorElement.getName().contains("KubernetesExecutor"))
+ executorElement.addElement("stagingOnPV").setText("false");
+ }
+ }
+ }
+ }
+ dom.writeToFile(file, false);
+ }
+ }
+ }
}
\ No newline at end of file
diff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/jobexecutor/JobExecutor.java b/server-core/src/main/java/io/onedev/server/model/support/administration/jobexecutor/JobExecutor.java
index ce888625f9..c2e6f6e89f 100644
--- a/server-core/src/main/java/io/onedev/server/model/support/administration/jobexecutor/JobExecutor.java
+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/jobexecutor/JobExecutor.java
@@ -43,8 +43,6 @@ public abstract class JobExecutor implements Serializable {
private boolean sitePublishEnabled;
- private int cacheTTL = 7;
-
public boolean isEnabled() {
return enabled;
}
@@ -64,7 +62,7 @@ public abstract class JobExecutor implements Serializable {
this.name = name;
}
- @Editable(order=20, description="Enable this to allow to open interactive shell to diagnose running builds. "
+ @Editable(order=20, group = "Privilege Settings", description="Enable this to allow to open interactive shell to diagnose running builds. "
+ "<b class='text-danger'>WARNING</b>: Users with shell access can take control of the node used by "
+ "the executor. You should configure job requirement below to make sure the executor can only be "
+ "used by trusted jobs if this option is enabled")
@@ -77,7 +75,7 @@ public abstract class JobExecutor implements Serializable {
this.shellAccessEnabled = shellAccessEnabled;
}
- @Editable(order=30, description="Enable this to allow to run site publish step. OneDev will serve project "
+ @Editable(order=30, group = "Privilege Settings", description="Enable this to allow to run site publish step. OneDev will serve project "
+ "site files as is. To avoid XSS attack, make sure this executor can only be used by trusted jobs")
public boolean isSitePublishEnabled() {
return sitePublishEnabled;
@@ -87,7 +85,7 @@ public abstract class JobExecutor implements Serializable {
this.sitePublishEnabled = sitePublishEnabled;
}
- @Editable(order=40, description = "Enable this to allow to run html report publish step. To avoid XSS attach, " +
+ @Editable(order=40, group = "Privilege Settings", description = "Enable this to allow to run html report publish step. To avoid XSS attach, " +
"make sure this executor can only be used by trusted jobs")
public boolean isHtmlReportPublishEnabled() {
return htmlReportPublishEnabled;
@@ -112,18 +110,6 @@ public abstract class JobExecutor implements Serializable {
public void setJobRequirement(String jobRequirement) {
this.jobRequirement = jobRequirement;
}
-
- @Editable(order=50000, group="More Settings", description="Specify job cache TTL (time to live) by days. "
- + "OneDev may create multiple job caches even for same cache key to avoid cache conflicts when "
- + "running jobs concurrently. This setting tells OneDev to remove caches inactive for specified "
- + "time period to save disk space")
- public int getCacheTTL() {
- return cacheTTL;
- }
-
- public void setCacheTTL(int cacheTTL) {
- this.cacheTTL = cacheTTL;
- }
public abstract void execute(JobContext jobContext, TaskLogger jobLogger);
diff --git a/server-plugin/server-plugin-buildspec-dotnet/src/main/java/io/onedev/server/plugin/buildspec/dotnet/DotnetJobSuggestion.java b/server-plugin/server-plugin-buildspec-dotnet/src/main/java/io/onedev/server/plugin/buildspec/dotnet/DotnetJobSuggestion.java
index 59bcf8014c..2504bbacfe 100644
--- a/server-plugin/server-plugin-buildspec-dotnet/src/main/java/io/onedev/server/plugin/buildspec/dotnet/DotnetJobSuggestion.java
+++ b/server-plugin/server-plugin-buildspec-dotnet/src/main/java/io/onedev/server/plugin/buildspec/dotnet/DotnetJobSuggestion.java
@@ -44,7 +44,7 @@ public class DotnetJobSuggestion implements JobSuggestion {
job.getSteps().add(generateChecksum);
var setupCache = new SetupCacheStep();
- setupCache.setName("set up package cache");
+ setupCache.setName("set up nuget cache");
setupCache.setKey("nuget_packages_@file:checksum@");
setupCache.setPath("/root/.nuget/packages");
setupCache.getLoadKeys().add("nuget_packages");
diff --git a/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenJobSuggestion.java b/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenJobSuggestion.java
index 5240d8d099..c22c7a849e 100644
--- a/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenJobSuggestion.java
+++ b/server-plugin/server-plugin-buildspec-maven/src/main/java/io/onedev/server/plugin/buildspec/maven/MavenJobSuggestion.java
@@ -43,7 +43,7 @@ public class MavenJobSuggestion implements JobSuggestion {
job.getSteps().add(generateChecksum);
var setupCache = new SetupCacheStep();
- setupCache.setName("set up repository cache");
+ setupCache.setName("set up maven cache");
setupCache.setKey("maven_repository_@file:checksum@");
setupCache.setPath("/root/.m2/repository");
setupCache.getLoadKeys().add("maven_repository");
diff --git a/server-plugin/server-plugin-buildspec-node/src/main/java/io/onedev/server/plugin/buildspec/node/NodeJobSuggestion.java b/server-plugin/server-plugin-buildspec-node/src/main/java/io/onedev/server/plugin/buildspec/node/NodeJobSuggestion.java
index e3e6d9c388..d5d28ee346 100644
--- a/server-plugin/server-plugin-buildspec-node/src/main/java/io/onedev/server/plugin/buildspec/node/NodeJobSuggestion.java
+++ b/server-plugin/server-plugin-buildspec-node/src/main/java/io/onedev/server/plugin/buildspec/node/NodeJobSuggestion.java
@@ -294,7 +294,7 @@ public class NodeJobSuggestion implements JobSuggestion {
generateChecksum.setTargetFile("checksum");
var setupCache = new SetupCacheStep();
- setupCache.setName("set up package cache");
+ setupCache.setName("set up npm cache");
setupCache.setKey("node_modules_@file:checksum@");
setupCache.setPath("node_modules");
setupCache.getLoadKeys().add("node_modules");
diff --git a/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java b/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
index 7c77e5945a..5c1cde9159 100644
--- a/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
+++ b/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java
@@ -19,6 +19,7 @@ import io.onedev.server.OneDev;
import io.onedev.server.annotation.Editable;
import io.onedev.server.annotation.Horizontal;
import io.onedev.server.annotation.OmitName;
+import io.onedev.server.annotation.ShowCondition;
import io.onedev.server.buildspecmodel.inputspec.SecretInput;
import io.onedev.server.cluster.ClusterManager;
import io.onedev.server.entitymanager.SettingManager;
@@ -31,6 +32,8 @@ import io.onedev.server.plugin.executor.kubernetes.KubernetesExecutor.TestData;
import io.onedev.server.terminal.CommandlineShell;
import io.onedev.server.terminal.Shell;
import io.onedev.server.terminal.Terminal;
+import io.onedev.server.util.EditContext;
+import io.onedev.server.util.FilenameUtils;
import io.onedev.server.web.util.Testable;
import org.apache.commons.codec.binary.Hex;
import org.apache.commons.lang.SerializationUtils;
@@ -88,6 +91,12 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
private List<RegistryLogin> registryLogins = new ArrayList<>();
+ private boolean stagingOnPV;
+
+ private String storageClass;
+
+ private String storageSize;
+
private List<ServiceLocator> serviceLocators = new ArrayList<>();
private String configFile;
@@ -110,7 +119,7 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
private transient List<ImageMappingFacade> imageMappingFacades;
- @Editable(order=20, description="Optionally specify node selector of the job pods")
+ @Editable(order=500, group = "More Settings", description="Optionally specify node selector of the job pods")
public List<NodeSelectorEntry> getNodeSelector() {
return nodeSelector;
}
@@ -119,7 +128,7 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
this.nodeSelector = nodeSelector;
}
- @Editable(order=40, description="Optionally specify cluster role the job pods service account "
+ @Editable(order=600, group="More Settings", description="Optionally specify cluster role the job pods service account "
+ "binding to. This is necessary if you want to do things such as running other "
+ "Kubernetes pods in job command")
public String getClusterRole() {
@@ -141,7 +150,41 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
this.registryLogins = registryLogins;
}
- @Editable(order=400, description = "Specify cpu request for jobs using this executor. " +
+ @Editable(order=300, name="Staging on Persistent Volume")
+ public boolean isStagingOnPV() {
+ return stagingOnPV;
+ }
+
+ public void setStagingOnPV(boolean stagingOnPV) {
+ this.stagingOnPV = stagingOnPV;
+ }
+
+ private static boolean isStagingOnPVEnabled() {
+ return (boolean) EditContext.get().getInputValue("stagingOnPV");
+ }
+
+ @Editable(order=400, name="Persistent Volume Storage Class", placeholder = "Use default storage class")
+ @ShowCondition("isStagingOnPVEnabled")
+ public String getStorageClass() {
+ return storageClass;
+ }
+
+ public void setStorageClass(String storageClass) {
+ this.storageClass = storageClass;
+ }
+
+ @Editable(order=500, name="Persistent Volume Storage Size")
+ @ShowCondition("isStagingOnPVEnabled")
+ @NotEmpty
+ public String getStorageSize() {
+ return storageSize;
+ }
+
+ public void setStorageSize(String storageSize) {
+ this.storageSize = storageSize;
+ }
+
+ @Editable(order=400, group = "Resource Settings", description = "Specify cpu request for jobs using this executor. " +
"Check <a href='https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' target='_blank'>Kubernetes resource management</a> for details")
@NotEmpty
public String getCpuRequest() {
@@ -152,7 +195,7 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
this.cpuRequest = cpuRequest;
}
- @Editable(order=500, description = "Specify memory request for jobs using this executor. " +
+ @Editable(order=500, group="Resource Settings", description = "Specify memory request for jobs using this executor. " +
"Check <a href='https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' target='_blank'>Kubernetes resource management</a> for details")
@NotEmpty
public String getMemoryRequest() {
@@ -163,7 +206,7 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
this.memoryRequest = memoryRequest;
}
- @Editable(order=24990, group="More Settings", placeholder = "No limit", description = "" +
+ @Editable(order=24990, group="Resource Settings", placeholder = "No limit", description = "" +
"Optionally specify cpu limit for jobs using this executor. " +
"Check <a href='https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' target='_blank'>Kubernetes resource management</a> for details")
public String getCpuLimit() {
@@ -174,7 +217,7 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
this.cpuLimit = cpuLimit;
}
- @Editable(order=24995, group="More Settings", placeholder = "No limit", description = "" +
+ @Editable(order=24995, group="Resource Settings", placeholder = "No limit", description = "" +
"Optionally specify memory limit for jobs using this executor. " +
"Check <a href='https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' target='_blank'>Kubernetes resource management</a> for details")
public String getMemoryLimit() {
@@ -894,6 +937,24 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
var trustCertsConfigMapName = createTrustCertsConfigMap(namespace, jobLogger);
+ if (isStagingOnPV()) {
+ Map<Object, Object> pvcDef = newLinkedHashMap(
+ "apiVersion", "v1",
+ "kind", "PersistentVolumeClaim",
+ "metadata", newLinkedHashMap(
+ "name", "build-home",
+ "namespace", namespace));
+ Map<Object, Object> pvcSpecDef = newLinkedHashMap(
+ "accessModes", newArrayList("ReadWriteOnce"),
+ "resources", newLinkedHashMap(
+ "requests", newLinkedHashMap(
+ "storage", getStorageSize())));
+ if (getStorageClass() != null)
+ pvcSpecDef.put("storageClassName", getStorageClass());
+ pvcDef.put("spec", pvcSpecDef);
+ createResource(pvcDef, Sets.newHashSet(), jobLogger);
+ }
+
osInfo = getBaselineOsInfo(getNodeSelector(), jobLogger);
Map<String, Object> podSpec = new LinkedHashMap<>();
@@ -1111,9 +1172,17 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
if (!getNodeSelector().isEmpty())
podSpec.put("nodeSelector", toMap(getNodeSelector()));
- Map<Object, Object> buildHomeVolume = newLinkedHashMap(
- "name", "build-home",
- "emptyDir", newLinkedHashMap());
+ Map<Object, Object> buildHomeVolume;
+ if (isStagingOnPV()) {
+ buildHomeVolume = newLinkedHashMap(
+ "name", "build-home",
+ "persistentVolumeClaim", newLinkedHashMap(
+ "claimName", "build-home"));
+ } else {
+ buildHomeVolume = newLinkedHashMap(
+ "name", "build-home",
+ "emptyDir", newLinkedHashMap());
+ }
List<Object> volumes = newArrayList(buildHomeVolume);
if (trustCertsConfigMapName != null) {
volumes.add(newLinkedHashMap(
@@ -1132,6 +1201,7 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
"spec", podSpec);
createResource(podDef, Sets.newHashSet(), jobLogger);
+
String podFQN = namespace + "/" + POD_NAME;
AtomicReference<String> nodeNameRef = new AtomicReference<>(null);
@@ -1265,11 +1335,13 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
var volumeMounts = new ArrayList<>();
int index = 1;
for (var cachePath: cachePaths) {
- var volumeMount = newLinkedHashMap(
- "name", "build-home",
- "mountPath", cachePath,
- "subPath", "cache/" + index);
- volumeMounts.add(volumeMount);
+ if (FilenameUtils.getPrefixLength(cachePath) > 0) {
+ var volumeMount = newLinkedHashMap(
+ "name", "build-home",
+ "mountPath", cachePath,
+ "subPath", "cache/" + index);
+ volumeMounts.add(volumeMount);
+ }
index++;
}
return volumeMounts;
diff --git a/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesResource.java b/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesResource.java
index 0f82daadf5..aa19d9c3cc 100644
--- a/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesResource.java
+++ b/server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesResource.java
@@ -222,8 +222,7 @@ public class KubernetesResource {
@GET
@Path("/test")
- public Response test() {
- String jobToken = SecurityUtils.getBearerToken(request);
+ public Response test(@QueryParam("jobToken") String jobToken) {
if (jobToken != null)
return Response.ok().build();
else
diff --git a/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java b/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
index 68e1042ff4..f8914f03ce 100644
--- a/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
+++ b/server-plugin/server-plugin-executor-serverdocker/src/main/java/io/onedev/server/plugin/executor/serverdocker/ServerDockerExecutor.java
@@ -119,7 +119,7 @@ public class ServerDockerExecutor extends JobExecutor implements RegistryLoginAw
this.dockerSockPath = dockerSockPath;
}
- @Editable(order=520, group="More Settings", description="Whether or not to mount docker sock into job container to "
+ @Editable(order=520, group="Privilege Settings", description="Whether or not to mount docker sock into job container to "
+ "support docker operations in job commands<br>"
+ "<b class='text-danger'>WARNING</b>: Malicious jobs can take control of whole OneDev "
+ "by operating the mounted docker sock. You should configure job requirement above to make sure the " +