Add runtime field to Docker agent template container settings#1202
Open
Ross-s wants to merge 1 commit intojenkinsci:masterfrom
Open
Add runtime field to Docker agent template container settings#1202Ross-s wants to merge 1 commit intojenkinsci:masterfrom
Ross-s wants to merge 1 commit intojenkinsci:masterfrom
Conversation
Introduces the ability to specify a custom OCI runtime for Docker containers via the `runtime` property in DockerTemplateBase.
There was a problem hiding this comment.
Pull request overview
This PR adds per-template Docker runtime selection to the Jenkins Docker agent configuration so individual agent templates can request a non-default container runtime without changing the Docker daemon’s global default. It extends DockerTemplateBase, exposes the setting in the Jenkins UI, and applies it when building the container HostConfig.
Changes:
- Added a new
runtimefield toDockerTemplateBasewith databinding support and container creation wiring viaHostConfig.withRuntime(...). - Added a new Runtime entry and inline help to the Docker template configuration UI.
- Added unit coverage for applying the runtime during
fillContainerConfig(...).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/main/java/com/nirima/jenkins/plugins/docker/DockerTemplateBase.java |
Adds the runtime property, setter/getter, and applies it to Docker container host configuration. |
src/main/resources/com/nirima/jenkins/plugins/docker/DockerTemplateBase/config.jelly |
Exposes the new runtime field in the Jenkins agent template configuration form. |
src/main/resources/com/nirima/jenkins/plugins/docker/DockerTemplateBase/help-runtime.html |
Documents the new runtime option for users in the UI help. |
src/test/java/com/nirima/jenkins/plugins/docker/DockerTemplateBaseTest.java |
Adds tests for runtime handling in container configuration assembly. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| @DataBoundSetter | ||
| public void setRuntime(@CheckForNull String runtime) { | ||
| this.runtime = runtime == null || runtime.isEmpty() ? null : runtime; |
| private @CheckForNull List<String> capabilitiesToAdd; | ||
| private @CheckForNull List<String> capabilitiesToDrop; | ||
|
|
||
| private @CheckForNull String runtime; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a
runtimefield toDockerTemplateBaseso users can specify acontainer runtime (e.g.
sysbox-runc,nvidia) per agent template,without having to set a default runtime globally in
/etc/docker/daemon.json.Closes #1031
What changed
runtimefield toDockerTemplateBaseHostConfig.withRuntime(runtime)when creating containers<f:entry>for Runtime inconfig.jelly(after SecurityOptions), with inline help
Why
The
HostConfigAPI in docker-java already supports.withRuntime(String)but it was never exposed in the plugin UI. This is a minimal, additive
change with no impact on existing behaviour — the field defaults to
nulland is only applied when non-empty.
Use case driving this: running Jenkins agents with
Nestybox Sysbox for secure
Docker-in-Docker without
--privileged, which requires--runtime=sysbox-runc.Testing done
DockerTemplateBaseTest#testRuntimeField— verifies fieldis stored and retrieved correctly
sysbox-runcagent via Jenkins Docker Build Cloud;docker infoinside the agent confirms DinD is functionalSubmitter checklist