Skip to content

The Unified and Autonomous Development Platform

feat: Able to turn off always pull option for docker images (OD-1976)

Robin Shenf414e3215bb6
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 596796b86e..e59025cd53 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
@@ -6575,5 +6575,29 @@ public class DataMigrator {
}
}
+ private void migrate169(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()) {
+ if (executorElement.getName().contains("ServerDockerExecutor")
+ || executorElement.getName().contains("RemoteDockerExecutor")
+ || executorElement.getName().contains("KubernetesExecutor")) {
+ executorElement.addElement("alwaysPullImage").setText("true");
+ }
+ }
+ }
+ }
+ }
+ dom.writeToFile(file, false);
+ }
+ }
+ }
+
}
\ No newline at end of file
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 3691f35b78..e66110f6f1 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
@@ -110,6 +110,8 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
private String memoryLimit;
+ private boolean alwaysPullImage = true;
+
private List<ImageMapping> imageMappings = new ArrayList<>();
private transient volatile OsInfo osInfo;
@@ -232,7 +234,18 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
public void setMemoryLimit(String memoryLimit) {
this.memoryLimit = memoryLimit;
}
-
+
+ @Editable(order=600, group="Privilege Settings", description = "Whether or not to always pull image when " +
+ "run container or build images. This option should be enabled to avoid images being replaced by " +
+ "malicious jobs running on same node")
+ public boolean isAlwaysPullImage() {
+ return alwaysPullImage;
+ }
+
+ public void setAlwaysPullImage(boolean alwaysPullImage) {
+ this.alwaysPullImage = alwaysPullImage;
+ }
+
@Editable(order=25000, group="More Settings", description="Optionally specify where to run service pods "
+ "specified in job. The first matching locator will be used. If no any locators are found, "
+ "node selector of the executor will be used")
@@ -742,8 +755,9 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
Map<String, Object> podSpec = new LinkedHashMap<>();
Map<Object, Object> containerSpec = newLinkedHashMap(
"name", "default",
- "image", mapImage(jobService.getImage()),
- "imagePullPolicy", "Always");
+ "image", mapImage(jobService.getImage()));
+ if (isAlwaysPullImage())
+ containerSpec.put("imagePullPolicy", "Always");
Map<Object, Object> resourcesSpec = newLinkedHashMap(
"requests", newLinkedHashMap(
"cpu", getCpuRequest(),
@@ -1066,6 +1080,8 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
stepContainerSpec = newHashMap(
"name", containerName,
"image", mapImage(execution.getImage()));
+ if (isAlwaysPullImage())
+ stepContainerSpec.put("imagePullPolicy", "Always");
if (commandFacade.isUseTTY())
stepContainerSpec.put("tty", true);
var volumeMounts = buildVolumeMounts(cachePaths);
@@ -1086,6 +1102,8 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
stepContainerSpec = newHashMap(
"name", containerName,
"image", helperImage);
+ if (isAlwaysPullImage())
+ stepContainerSpec.put("imagePullPolicy", "Always");
var volumeMounts = buildVolumeMounts(cachePaths);
volumeMounts.addAll(commonVolumeMounts);
stepContainerSpec.put("volumeMounts", SerializationUtils.clone(volumeMounts));
@@ -1150,6 +1168,8 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
"args", initArgs,
"env", SerializationUtils.clone(commonEnvs),
"volumeMounts", SerializationUtils.clone(volumeMounts));
+ if (isAlwaysPullImage())
+ initContainerSpec.put("imagePullPolicy", "Always");
Map<Object, Object> sidecarContainerSpec = newLinkedHashMap(
"name", "sidecar",
@@ -1158,6 +1178,8 @@ public class KubernetesExecutor extends JobExecutor implements RegistryLoginAwar
"args", sidecarArgs,
"env", SerializationUtils.clone(commonEnvs),
"volumeMounts", SerializationUtils.clone(volumeMounts));
+ if (isAlwaysPullImage())
+ sidecarContainerSpec.put("imagePullPolicy", "Always");
sidecarContainerSpec.put("resources", newLinkedHashMap("requests", newLinkedHashMap(
"cpu", getCpuRequest(),
diff --git a/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java b/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java
index ac47a61049..f7a51e31e9 100644
--- a/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java
+++ b/server-plugin/server-plugin-executor-remotedocker/src/main/java/io/onedev/server/plugin/executor/remotedocker/RemoteDockerExecutor.java
@@ -112,7 +112,7 @@ public class RemoteDockerExecutor extends ServerDockerExecutor {
jobContext.getBuildNumber(), jobContext.getActions(), jobContext.getRetried(),
jobContext.getServices(), registryLogins, builtInRegistryUrl, imageMappings,
isMountDockerSock(), getDockerSockPath(), getDockerBuilder(), getCpuLimit(),
- getMemoryLimit(), getRunOptions(), getNetworkOptions());
+ getMemoryLimit(), getRunOptions(), getNetworkOptions(), isAlwaysPullImage());
try {
return call(agentSession, jobData, jobContext.getTimeout()*1000L);
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 cabc973ec0..027ef70e33 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
@@ -61,6 +61,8 @@ public class ServerDockerExecutor extends JobExecutor implements RegistryLoginAw
private String runOptions;
+ private boolean alwaysPullImage = true;
+
private String dockerExecutable;
private boolean mountDockerSock;
@@ -133,7 +135,18 @@ public class ServerDockerExecutor extends JobExecutor implements RegistryLoginAw
public void setDockerBuilder(String dockerBuilder) {
this.dockerBuilder = dockerBuilder;
}
+
+ @Editable(order=600, group="Privilege Settings", description = "Whether or not to always pull image when " +
+ "run container or build images. This option should be enabled to avoid images being replaced by " +
+ "malicious jobs running on same machine")
+ public boolean isAlwaysPullImage() {
+ return alwaysPullImage;
+ }
+ public void setAlwaysPullImage(boolean alwaysPullImage) {
+ this.alwaysPullImage = alwaysPullImage;
+ }
+
@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 "
@@ -333,7 +346,9 @@ public class ServerDockerExecutor extends JobExecutor implements RegistryLoginAw
var useProcessIsolation = isUseProcessIsolation(docker, image, osInfo, jobLogger);
docker.clearArgs();
- docker.addArgs("run", "--pull=always", "--name=" + containerName, "--network=" + network);
+ docker.addArgs("run", "--name=" + containerName, "--network=" + network);
+ if (isAlwaysPullImage())
+ docker.addArgs("--pull=always");
if (runAs != null)
docker.addArgs("--user", runAs);
else if (!SystemUtils.IS_OS_WINDOWS)
@@ -452,7 +467,8 @@ public class ServerDockerExecutor extends JobExecutor implements RegistryLoginAw
var builtInRegistryLogin = new BuiltInRegistryLogin(serverUrl,
jobContext.getJobToken(), buildImageFacade.getBuiltInRegistryAccessToken());
callWithDockerConfig(docker, getRegistryLoginFacades(), builtInRegistryLogin, () -> {
- buildImage(docker, getDockerBuilder(), buildImageFacade, hostBuildHome, jobLogger);
+ buildImage(docker, getDockerBuilder(), buildImageFacade, hostBuildHome,
+ isAlwaysPullImage(), jobLogger);
return null;
});
} else if (facade instanceof RunImagetoolsFacade) {