jenkins/inbound-agent pulls statistics

Docker image for inbound Jenkins agents

: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 controller. This agent is powered by the Jenkins Remoting library, which version is being taken from the base Docker Agent image.

See Using Agents for more info.

Configuring agents with this container image

Setup the agent on Jenkins

1. Go to your Jenkins dashboard
2. Go to Manage Jenkins option in main menu
3. Go to Nodes item in System Configuration
4. Go to New Node option in side menu
5. Fill the Node(agent) name and select the type; (e.g. Name: agent1, Type: Permanent Agent)
6. Now fill the fields like remote root directory, labels, # of executors, etc.

• Launch method is Launch agent by connecting it to the controller

1. Press the Save button and the agent1 will be registered, but offline for the time being. Click on it.
2. You should now see the secret. Use the secret value to pass it to the argument of container, or set to JENKINS_SECRET as environment variable.

Running this container

To run a Docker container

Note Remember to replace the <secret> and <agent name> for secret and agent name, which can be you can get(and set) from above section. Your agent node should be possible to connect to Jenkins controller with agent port (not Jenkins server's port like 80, 443, 8080), which can be set in Manage Jenkins > Security > Agent. Default port is 50000.

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-ltsc2022 -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-ltsc2022 -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_HOME
• JENKINS_JAVA_OPTS : Java Options to use for the remoting process, otherwise obtained from JAVA_OPTS, Warning :exclamation: For more information on Windows usage, please see the Windows Jenkins Java Opts section below.
• JENKINS_AGENT_FILE : Jenkins agent jar file location, /usr/share/jenkins/agent.jar will be used if this is not set
• REMOTING_OPTS : Generic way to pass additional CLI options to agent.jar (see -help)

Deprecated environment variables (prefer setting REMOTING_OPTS)…