Skip to content

The Unified and Autonomous Development Platform

feat: able to specify docker run options for run container step (#1451)

Robin Shen9eac5fd57b16
diff --git a/pom.xml b/pom.xml
index 0e6a6647c4..3334fe46a6 100644
--- a/pom.xml
+++ b/pom.xml
@@ -615,7 +615,7 @@
</repositories>
<properties>
<commons.version>2.7.16</commons.version>
- <agent.version>1.8.21</agent.version>
+ <agent.version>1.8.22</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-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java b/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java
index 40c6e4148f..89b885931b 100644
--- a/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java
+++ b/server-core/src/main/java/io/onedev/server/buildspec/step/RunContainerStep.java
@@ -29,6 +29,8 @@ public class RunContainerStep extends Step {
private String image;
+ private String opts;
+
private String args;
private List<EnvVar> envVars = new ArrayList<>();
@@ -47,7 +49,7 @@ public class RunContainerStep extends Step {
Map<String, String> mountMap = new HashMap<>();
for (VolumeMount mount: getVolumeMounts())
mountMap.put(mount.getSourcePath(), mount.getTargetPath());
- return new RunContainerFacade(getImage(), getArgs(), envMap, getWorkingDir(), mountMap, isUseTTY());
+ return new RunContainerFacade(getImage(), getOpts(), getArgs(), envMap, getWorkingDir(), mountMap, isUseTTY());
}
@Editable(order=100, description="Specify container image to run")
@@ -61,7 +63,17 @@ public class RunContainerStep extends Step {
this.image = image;
}
- @Editable(order=200, name="Arguments", description="Specify container arguments separated by space. "
+ @Editable(order=150, name="Options", description = "Optionally specify space-separated options to run container")
+ @Interpolative(variableSuggester = "suggestVariables")
+ public String getOpts() {
+ return opts;
+ }
+
+ public void setOpts(String opts) {
+ this.opts = opts;
+ }
+
+ @Editable(order=200, name="Arguments", description="Optionally specify container arguments separated by space. "
+ "Single argument containing space should be quoted")
@Interpolative(variableSuggester="suggestVariables")
public String getArgs() {
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 04ac479752..bd5f4e0522 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
@@ -1,6 +1,7 @@
package io.onedev.server.plugin.executor.serverdocker;
import com.google.common.base.Preconditions;
+import com.google.common.base.Splitter;
import io.onedev.agent.DockerExecutorUtils;
import io.onedev.agent.ExecutorUtils;
import io.onedev.agent.job.FailedException;
@@ -324,7 +325,7 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
CompositeFacade entryFacade = new CompositeFacade(jobContext.getActions());
boolean successful = entryFacade.execute(new LeafHandler() {
- private int runStepContainer(String image, @Nullable String entrypoint,
+ private int runStepContainer(String image, @Nullable String entrypoint, List<String> options,
List<String> arguments, Map<String, String> environments,
@Nullable String workingDir, Map<String, String> volumeMounts,
List<Integer> position, boolean useTTY) {
@@ -403,6 +404,8 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
if (isUseProcessIsolation(newDocker(), image, osInfo, jobLogger))
docker.addArgs("--isolation=process");
+ docker.addArgs(options.toArray(new String[options.size()]));
+
docker.addArgs(image);
docker.addArgs(arguments.toArray(new String[arguments.size()]));
docker.processKiller(newDockerKiller(newDocker(), containerName, jobLogger));
@@ -436,8 +439,8 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
hostBuildHome, commandFacade, osInfo, hostAuthInfoDir.get() != null);
int exitCode = runStepContainer(execution.getImage(), entrypoint.executable(),
- entrypoint.arguments(), new HashMap<>(), null, new HashMap<>(),
- position, commandFacade.isUseTTY());
+ new ArrayList<>(), entrypoint.arguments(), new HashMap<>(), null,
+ new HashMap<>(), position, commandFacade.isUseTTY());
if (exitCode != 0) {
long duration = System.currentTimeMillis() - time;
@@ -450,10 +453,15 @@ public class ServerDockerExecutor extends JobExecutor implements DockerAware, Te
} else if (facade instanceof RunContainerFacade) {
RunContainerFacade runContainerFacade = (RunContainerFacade) facade;
OsContainer container = runContainerFacade.getContainer(osInfo);
+ List<String> options;
+ if (container.getOpts() != null)
+ options = Splitter.on(" ").trimResults().omitEmptyStrings().splitToList(container.getOpts());
+ else
+ options = new ArrayList<>();
List<String> arguments = new ArrayList<>();
if (container.getArgs() != null)
arguments.addAll(Arrays.asList(StringUtils.parseQuoteTokens(container.getArgs())));
- int exitCode = runStepContainer(container.getImage(), null, arguments, container.getEnvMap(),
+ int exitCode = runStepContainer(container.getImage(), null, options, arguments, container.getEnvMap(),
container.getWorkingDir(), container.getVolumeMounts(), position, runContainerFacade.isUseTTY());
if (exitCode != 0) {
long duration = System.currentTimeMillis() - time;