Note: This plugin is officially "up for adoption". It would benefit from having a new maintainer who uses it "for real work" and is thus able to test things "for real" before release instead of relying purely on the unit tests.
This plugin allows containers to be dynamically provisioned as Jenkins nodes using Docker. It is a Jenkins Cloud plugin for Docker.
The aim of this docker plugin is to be able to use a Docker host to dynamically provision a docker container as a Jenkins agent node, let that run a single build, then tear-down that node, without the build process (or Jenkins job definition) requiring any awareness of docker.
The Jenkins administrator configures Jenkins with knowledge of one or more docker hosts (or swarms), knowledge of one or more "templates" (which describe the labels/tags that this template provides, the docker image, how to start it, etc) and Jenkins can then run docker containers to provide Jenkins (agent) Nodes on which Jenkins can run builds.
- Software licence
- Support and contribution guide
Note: There is more than one docker plugin for Jenkins. While this can be confusing for end-users, it's even more confusing when end users report bugs in the wrong place. e.g. if you are using Jenkins pipeline / workflow / Jenkinsfile builds with code including terms like
docker.image etc then you're using the
docker-workflow plugin and should go to its repository instead of this one.
Note: This plugin does not use the OS's native docker client; it uses docker-java. You do not need to install a docker client on Jenkins or on your agents to use this plugin.
Note: This plugin does not provide a Docker daemon; it allows Jenkins to use a docker daemon. i.e. Once you've installed docker somewhere, this plugin will allow Jenkins to make use of it.
A quick setup is :
- get a docker environment running
- follow the instructions for creating a docker image that can be used as a Jenkins Agent or use one of the pre-built images e.g. jenkins/inbound-agent
Follow the installation steps on the docker website.
If your Jenkins instance is not on the same OS as the docker install, you will need to open the docker TCP port so that Jenkins can communicate with the docker daemon. This can be achieved by editing the docker config file and setting (for example)
DOCKER_OPTS="-H tcp://0.0.0.0:2376 -H unix:///var/run/docker.sock"
The docker configuration file location will depend your system, but it is likely to be
Multiple Docker Hosts
If you want to use more than just one physical node to run containers, you can use Docker Swarm Standalone or you can define more than one docker "cloud". The docker engine swarm mode API is not supported (at present; enhancement contributions would be welcomed).
To use the standalone swarm, follow docker swarm standalone instructions and configure Jenkins with the swarm's API endpoint.
Docker plugin is a "Cloud" implementation. You'll need to edit Jenkins system configuration (Jenkins -> Manage -> System configuration) and add a new Cloud of type "Docker".
Configure Docker (or Swarm standalone) API URL with required credentials. The test button lets you check the connection.
Then configure Agent templates, assigning them labels that you can use so your jobs select the appropriate template, and set the docker container to be run with whatever container settings you require.
Creating a docker image
You need a docker image that can be used to run Jenkins agent runtime. Depending on the launch method you select, there's some prerequisites for the Docker image to be used:
Launch via SSH
- sshd server and a JDK installed. You can use jenkins/ssh-agent as a basis for a custom image.
- a SSH key (based on the unique Jenkins instance identity) can be injected in container on startup, you don't need any credential set as long as you use standard openssl sshd. For backward compatibilityÂ orÂ non-standard sshd packaged in your docker image, you also have option to provide manually configured ssh credentials
- Note: If the docker container's host SSH key is not trusted by Jenkins (usually the case) then you'll need to set the SSH host key verification method to "non-verifying".
Launch via JNLP
- a JDK installed. You can use jenkins/inbound-agent as a basis for a custom image.
- Jenkins controller URL has to be reachable from container.
- container will be configured automatically with agent's name and secret, so you don't need any special configuration of the container.
- a JDK installed. You can use jenkins/agent as a basis for a custom image.Â
To create a custom image and bundle your favorite tools, create a
Dockerfile with the
FROM to point to one of the jenkins/*-agent reference images, and install everything needed for your own usage, e.g.
FROM jenkins/inbound-agent RUN apt-get update && apt-get install XXX COPY your-favorite-tool-here
Note on ENTRYPOINT
Avoid overriding the docker command, as the SSH Launcher relies on it.
You can use an Entrypoint to run some side service inside your build agent container before the agent runtime starts and establish a connection ... but you MUST ensure your entrypoint eventually runs the passed command:
More information can be obtained from the online help built into the Jenkins web UI. Most configurable fields have explanatory text. This, combined with knowledge of docker itself, should answer most questions.
Configuration as code
Jenkins and the docker-plugin can be configured using Groovy code and/or using the JCasC plugin.
If you're unsure which method to use, use JCasC.
For example, this configuration script could be run automatically upon Jenkins post-initialization or through the Jenkins script console. If run, this script will configure the docker-plugin to look for a docker daemon running within the same OS as the Jenkins controller (connecting to Docker service through
unix:///var/run/docker.sock) and with the containers connecting to Jenkins using the "attach" method.
Install the configuration-as-code plugin and follow its example.