Skip to content

The Unified and Autonomous Development Platform

feat: Able to specify options such as gateway/subnet when create docker network of CI job (#1393)

Robin Shen0fd5bb70dd9a
diff --git a/pom.xml b/pom.xml
index 60e558cb2b..8ad64331bc 100644
--- a/pom.xml
+++ b/pom.xml
@@ -615,7 +615,7 @@
</repositories>
<properties>
<commons.version>2.7.15</commons.version>
- <agent.version>1.8.11</agent.version>
+ <agent.version>1.8.12</agent.version>
<slf4j.version>1.7.36</slf4j.version>
<logback.version>1.2.11</logback.version>
<antlr.version>4.7.2</antlr.version>
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 ce3ee7acae..e4290ea13e 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
@@ -2,7 +2,6 @@ package io.onedev.server.plugin.executor.remotedocker;
import io.onedev.agent.Message;
import io.onedev.agent.MessageTypes;
-import io.onedev.agent.WebsocketUtils;
import io.onedev.agent.job.DockerJobData;
import io.onedev.agent.job.TestDockerJobData;
import io.onedev.commons.utils.ExplicitException;
@@ -124,7 +123,7 @@ public class RemoteDockerExecutor extends ServerDockerExecutor {
jobContext.getProjectId(), jobContext.getRefName(), jobContext.getCommitId().name(),
jobContext.getBuildNumber(), jobContext.getActions(), jobContext.getRetried(),
services, registryLogins, isMountDockerSock(), getDockerSockPath(),
- getCpuLimit(), getMemoryLimit(), getRunOptions());
+ getCpuLimit(), getMemoryLimit(), getRunOptions(), getNetworkOptions());
try {
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 17b7d253e3..c9b2412fdf 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
@@ -29,7 +29,6 @@ import io.onedev.server.terminal.CommandlineShell;
import io.onedev.server.terminal.Shell;
import io.onedev.server.terminal.Terminal;
import io.onedev.server.util.DateUtils;
-import io.onedev.server.util.EditContext;
import io.onedev.server.validation.Validatable;
import io.onedev.server.web.util.Testable;
import org.apache.commons.lang3.SystemUtils;
@@ -67,6 +66,8 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
private String dockerSockPath;
+ private String networkOptions;
+
private String cpuLimit;
private String memoryLimit;
@@ -125,6 +126,16 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
this.mountDockerSock = mountDockerSock;
}
+ @Editable(order=530, group="More Settings", description = "Optionally specify docker options to create network. " +
+ "Multiple options should be separated by space, and single option containing spaces should be quoted")
+ public String getNetworkOptions() {
+ return networkOptions;
+ }
+
+ public void setNetworkOptions(String networkOptions) {
+ this.networkOptions = networkOptions;
+ }
+
@Editable(order=50010, group="More Settings", placeholder = "No limit", description = "" +
"Optionally specify cpu limit of jobs/services using this executor. This will be " +
"used as option <a href='https://docs.docker.com/config/containers/resource_constraints/#cpu' target='_blank'>--cpus</a> " +
@@ -149,7 +160,8 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
this.memoryLimit = memoryLimit;
}
- @Editable(order=50050, group="More Settings", description="Optionally specify options to run container")
+ @Editable(order=50050, group="More Settings", description="Optionally specify docker options to run container. " +
+ "Multiple options should be separated by space, and single option containing spaces should be quoted")
public String getRunOptions() {
return runOptions;
}
@@ -254,7 +266,7 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
login(jobLogger);
- createNetwork(newDocker(), network, jobLogger);
+ createNetwork(newDocker(), network, getNetworkOptions(), jobLogger);
try {
OsInfo osInfo = OneDev.getInstance(OsInfo.class);
@@ -609,13 +621,24 @@ public class ServerDockerExecutor extends JobExecutor implements Testable<TestDa
String reservedOptions[] = new String[] {"-w", "--workdir", "-d", "--detach", "-a", "--attach", "-t", "--tty",
"-i", "--interactive", "--rm", "--restart", "--name"};
if (hasOptions(arguments, reservedOptions)) {
- StringBuilder errorMessage = new StringBuilder("Can not use options: "
+ StringBuilder errorMessage = new StringBuilder("Can not use reserved options: "
+ Joiner.on(", ").join(reservedOptions));
context.buildConstraintViolationWithTemplate(errorMessage.toString())
.addPropertyNode("runOptions").addConstraintViolation();
isValid = false;
}
}
+ if (getNetworkOptions() != null) {
+ String[] arguments = StringUtils.parseQuoteTokens(getNetworkOptions());
+ String reservedOptions[] = new String[] {"-d", "--driver"};
+ if (hasOptions(arguments, reservedOptions)) {
+ StringBuilder errorMessage = new StringBuilder("Can not use reserved options: "
+ + Joiner.on(", ").join(reservedOptions));
+ context.buildConstraintViolationWithTemplate(errorMessage.toString())
+ .addPropertyNode("networkOptions").addConstraintViolation();
+ isValid = false;
+ }
+ }
if (!isValid)
context.disableDefaultConstraintViolation();
return isValid;