jenkins/jnlp-slave
a Jenkins agent which can connect to Jenkins using JNLP4 or Websocket protocols
100M+
:exclamation: Warning! This image used to be published as jenkinsci/jnlp-slave and jenkins/jnlp-slave. These images are deprecated, use jenkins/inbound-agent.
This is an image for Jenkins agents using TCP or WebSockets to establish inbound connection to the Jenkins master. 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.
To run a Docker container
Linux agent:
docker run --init jenkins/inbound-agent -url http://jenkins-server:port <secret> <agent name>
Note: --init
is necessary for correct subprocesses handling (zombie reaping)
Windows agent:
docker run jenkins/inbound-agent:windowsservercore-ltsc2019 -Url http://jenkins-server:port -Secret <secret> -Name <agent name>
To run a Docker container with Work Directory
Linux agent:
docker run --init jenkins/inbound-agent -url http://jenkins-server:port -workDir=/home/jenkins/agent <secret> <agent name>
Windows agent:
docker run jenkins/inbound-agent:windowsservercore-ltsc2019 -Url http://jenkins-server:port -WorkDir=C:/Jenkins/agent -Secret <secret> -Name <agent name>
Optional environment variables:
JENKINS_JAVA_BIN
: Path to Java executable to use instead of the default in PATH or obtained from JAVA_HOMEJENKINS_JAVA_OPTS
: Java Options to use for the remoting process, otherwise obtained from JAVA_OPTSJENKINS_URL
: url for the Jenkins server, can be used as a replacement to -url
option, or to set alternate jenkins URLJENKINS_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 argumentJENKINS_AGENT_NAME
: agent name, if not set as an argumentJENKINS_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 TCPJENKINS_DIRECT_CONNECTION
: (HOST:PORT
) Connect directly to this TCP agent port, skipping the HTTP(S) connection parameter download.JENKINS_INSTANCE_IDENTITY
: The base64 encoded InstanceIdentity byte array of the Jenkins master. When this is set, the agent skips connecting to an HTTP(S) port for connection info.JENKINS_PROTOCOLS
: Specify the remoting protocols to attempt when JENKINS_INSTANCE_IDENTITY
is provided.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.
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.
docker pull jenkins/jnlp-slave