A Jenkins agent image which allows using SSH to establish the connection. It can be used together with the SSH Build Agents plugin or other similar plugins.
See Jenkins Distributed builds for more info.
To run a Docker container
docker run -d --rm --name=agent --publish 2200:22 -e "JENKINS_AGENT_SSH_PUBKEY=<public_key>" jenkins/ssh-agent-d: To start a container in detached mode, use the-doption. Containers started in detached mode exit when the root process used to run the container exits, unless you also specify the --rm option.--rm: If you use -d with --rm, the container is removed when it exits or when the daemon exits, whichever happens first.--name: Assigns a name to the container. If you do not specify a name, Docker generates a random name.--publish 2200:22: Publishes the host port 2200 to the agent container port 22 (SSH) to allow connection from the host withssh jenkins@localhost -p 2200
Please note none of these options are mandatory, they are just examples.
You will then be able to connect this agent using the SSH Build Agents plugin as "jenkins" with the matching private key.
When using the Linux image, you have to set the value of the Remote root directory to /home/jenkins/agent in the agent configuration UI.
When using the Windows image, you have to set the value of the Remote root directory to C:/Users/jenkins/Work in the agent configuration UI.
If you intend to use another directory than /home/jenkins/agent under Linux or C:/Users/jenkins/Work under Windows, don't forget to add it as a data volume.
docker run -v docker-volume-for-jenkins-ssh-agent:/home/jenkins/agent:rw jenkins/ssh-agent "<public key>"To use this image with Docker Plugin, you need to pass the public SSH key using environment variable JENKINS_AGENT_SSH_PUBKEY and not as a startup argument.
In Environment field of the Docker Template (advanced section), just add:
JENKINS_AGENT_SSH_PUBKEY=<YOUR PUBLIC SSH KEY HERE>
Don't put quotes around the public key.
Please note that you have to set the value of the Remote File System Root to /home/jenkins/agent in the Docker Agent Template configuration UI.
If you intend to use another directory than /home/jenkins/agent, don't forget to add it as a data volume.
You should be all set.
Should you need to extend the image, you could use something along those lines:
FROM jenkins/ssh-agent:debian-jdk17 as ssh-agent
# [...]
COPY --chown=jenkins mykey "${JENKINS_AGENT_HOME}"/.ssh/mykey
# [...]The image has several supported configurations, which can be accessed via the following tags:
${IMAGE_VERSION} can be found on the releases page.
latest,latest-jdk11,jdk11,latest-bookworm-jdk11,bookworm-jdk11,latest-debian-jdk11,debian-jdk11,${IMAGE_VERSION},${IMAGE_VERSION}-jdk11, (Dockerfile)latest-jdk17,jdk17,latest-bookworm-jdk17,bookworm-jdk17,latest-debian-jdk17,debian-jdk17,${IMAGE_VERSION}-jdk17, (Dockerfile)nanoserver-1809,nanoserver-ltsc2019,nanoserver-1809-jdk11,nanoserver-ltsc2019-jdk11,${IMAGE_VERSION}-nanoserver-1809,${IMAGE_VERSION}-nanoserver-ltsc2019,${IMAGE_VERSION}-nanoserver-1809-jdk11,${IMAGE_VERSION}-nanoserver-ltsc2019-jdk11(Dockerfile)windowsservercore-1809,windowsservercore-ltsc2019,windowsservercore-1809-jdk11,windowsservercore-ltsc2019-jdk11,${IMAGE_VERSION}-windowsservercore-1809,${IMAGE_VERSION}-windowsservercore-ltsc2019,${IMAGE_VERSION}-windowsservercore-1809-jdk11,${IMAGE_VERSION}-windowsservercore-ltsc2019-jdk11(Dockerfile)
Should you want to build this image on your machine (before submitting a pull request for example), please have a look at the pre-requisites:
- A GNU/Linux machine with Docker, a macOS machine with Docker Desktop, or a Windows machine with Docker for Windows installed
- Docker BuildX plugin installed on older versions of Docker (from
19.03). Docker Buildx is included in recent versions of Docker Desktop for Windows, macOS, and Linux. Docker Linux packages also include Docker Buildx when installed using the DEB or RPM packages. - GNU Make installed
- jq installed
- GNU Bash installed
- git installed
- curl installed
If you want to see the target images that will be built, you can issue the following command:
make list
alpine_jdk11
alpine_jdk17
debian_jdk11
debian_jdk17If you want to build a specific image, you can issue the following command:
make build-<OS>_<JDK_VERSION>That would give for JDK 11 on Alpine Linux:
make build-alpine_jdk11Then, you can build all the images by running:
make buildIf you want to test the images, you can run:
make testIf you want to test a specific image, you can run:
make test-<OS>_<JDK_VERSION>That would give for JDK 11 on Alpine Linux:
make test-alpine_jdk11show gives us a detailed view of the images that will be built, with the tags, platforms, and Dockerfiles.
make show
{
"group": {
"default": {
"targets": [
"alpine_jdk17",
"alpine_jdk11",
"debian_jdk11",
"debian_jdk17",
]
}
},
"target": {
"alpine_jdk11": {
"context": ".",
"dockerfile": "alpine/Dockerfile",
"tags": [
"docker.io/jenkins/ssh-agent:alpine-jdk11",
"docker.io/jenkins/ssh-agent:latest-alpine-jdk11"
],
"platforms": [
"linux/amd64"
],
"output": [
"type=docker"
]
},
[...]bats is a dependency target. It will update the bats submodule and run the tests.
make bats
make: 'bats' is up to date.From a Powershell console, set first the IMAGE_TYPE environment variable defining the Windows flavor ("nanoserver"/"windowsservercore") and version you want to build.
For example:
New-Item -Path env:IMAGE_TYPE -Value "nanoserver-ltsc2019"
Then run .\build.ps1 to launch the build of the images for each jexdk specified in the build-windows.yaml docker compose file.
Run .\build.ps1 test if you also want to run the tests harness suit.
Run .\build.ps1 test -TestsDebug 'debug' to also get commands & stderr of tests, displayed on top of them.
You can set it to 'verbose' to also get stdout of every test command.
Finally, instead of passing -TestsDebug parameter to build.ps1, you can also set the desired value to $env:TESTS_DEBUG.
See GitHub Releases. Note that the changelogs and release tags were introduced in Dec 2019, and there are no entries for previous releases. Please consult with the commit history if needed.
