funbox / jenkins-agent

Shell wrapper for executing Jenkins Agents

About • Installation • Getting started • Usage • License

About

jenkins-agent is shell wrapper for executing Jenkins Agents. Jenkins Agent is supervised by systemd and connected to Jenkins Master via JNLP. The user is able to specify multiple agents in simple configuration file.

Installation

From prebuilt package for RHEL7/CentOS7

You can find RPM packages attached to releases on Release page.

From the source code

Copy shell program to system directory.

[sudo] cp SOURCES/jenkins-agent /usr/bin
[sudo] chown root:root /usr/bin/jenkins
[sudo] chmod ugo+x /usr/bin/jenkins

Copy systemd unit and apply changes.

[sudo] cp SOURCES/jenkins-agent@.service /etc/systemd/system/
[sudo] systemctl daemon-reload

Add configuration file to /etc/jenkins-agent/jenkins-agent.conf.

[sudo] cat << EOF > /etc/jenkins-agent/jenkins-agent.conf
[general]

  # Jenkins Slave Agent URL to jar
  jenkins_agent_url: https://ci.example.tld/jnlpJars/agent.jar
EOF

Getting started

Specify Jenkins Agent profile in configuration file. jenkins_url and jenkins_token options are mandatory.

[general]

  # Jenkins Slave Agent URL to jar
  jenkins_agent_url: https://ci.example.tld/jnlpJars/agent.jar

[example]

  # Jenkins URL
  jenkins_url: https://ci.example.tld/computer/example1

  # Jenkins secret token
  jenkins_token: cfthwlbsjccmvtbfdkj39whcznkfm3lxwhvnkgfcwcmjhkzxztrjps47ftzm3fwp

Launch systemd unit and make sure it will be launched after reboot.

[sudo] systemctl start [e-mail]
[sudo] systemctl enable [e-mail]

Done.

Usage

Usage: jenkins-agent {options}

Options

  --profile, -p profile       Jenkins Agent profile name
  --version, -v               Display version
  --help, -h                  Display this message

Examples

  jenkins-agent --profile example
  Run jenkins-agent with example profile specified in configuration file

License

Released under the MIT license (see LICENSE)