/docker-jnlp-slave

Docker image to run a JNLP slave

Primary LanguageShellMIT LicenseMIT

Jenkins JNLP Agent Docker image

Join the chat at https://gitter.im/jenkinsci/docker Docker Stars Docker Pulls Docker Automated build GitHub release

❗ Warning! This image used to be published as jenkinsci/jnlp-slave. That image name is deprecated, use jenkins/jnlp-slave.

This is an image for Jenkins agent (FKA "slave") using JNLP to establish connection. This agent is powered by the Jenkins Remoting library, which version is being taken from the base Docker Agent image.

See Jenkins Distributed builds for more info.

Running

To run a Docker container

Linux agent:

docker run jenkins/jnlp-slave -url http://jenkins-server:port <secret> <agent name>

Windows agent:

docker run jenkins/jnlp-agent:latest-windows -Url http://jenkins-server:port -Secret <secret> -Name <agent name>

To run a Docker container with Work Directory

Linux agent:

docker run jenkins/jnlp-slave -url http://jenkins-server:port -workDir=/home/jenkins/agent <secret> <agent name>

Windows agent:

docker run jenkins/jnlp-agent-windows -Url http://jenkins-server:port -WorkDir=C:/Jenkins/agent -Secret <secret> -Name <agent name>

Optional environment variables:

  • JENKINS_URL: url for the Jenkins server, can be used as a replacement to -url option, or to set alternate jenkins URL
  • JENKINS_TUNNEL: (HOST:PORT) connect to this agent host and port instead of Jenkins server, assuming this one do route TCP traffic to Jenkins master. Useful when when Jenkins runs behind a load balancer, reverse proxy, etc.
  • JENKINS_SECRET: agent secret, if not set as an argument
  • JENKINS_AGENT_NAME: agent name, if not set as an argument
  • JENKINS_AGENT_WORKDIR: agent work directory, if not set by optional parameter -workDir
  • JENKINS_WEB_SOCKET: true if the connection should be made via WebSocket rather than TCP

Configuration specifics

Enabled JNLP protocols

As of version 3.40-1 this image only supports the JNLP4-connect protocol. Earlier, long-unsupported protocols have been removed. As a result, Jenkins versions prior to 2.32 are no longer supported.

Amazon ECS

Make sure your ECS container agent is updated before running. Older versions do not properly handle the entryPoint parameter. See the entryPoint definition for more information.