Installing GoCD agent on Linux
- RPM based distributions (ie RedHat/CentOS/Fedora)
- Debian based distributions (ie Ubuntu)
- Managing the go-agent service on linux
- Configuring the go-agent
- Location of GoCD agent files
- Registering your agent with the server
Installation of the GoCD agent using the package manager will require root access on the machine. You are also required to have a java version 8 (same version as the GoCD server) for the agent to run.
The installer will create a user called go
if one does not exist on the machine. The home directory will be set to /var/go
. If you want to create your own go
user, make sure you do it before you install the GoCD agent.
RPM based distributions (ie RedHat/CentOS/Fedora)
The GoCD agent RPM installer has been tested on RedHat Enterprise Linux and CentOS. It should work on most RPM based Linux distributions.
If you prefer to use the YUM repository and install via YUM, paste the following in your shell —
sudo curl https://download.gocd.org/gocd.repo -o /etc/yum.repos.d/gocd.repo
sudo yum install -y java-1.8.0-openjdk #atleast Java 8 is required, you may use other jre/jdk if you prefer
Once you have the repository setup, execute
sudo yum install -y go-agent
Alternatively, if you have the agent RPM downloaded:
sudo yum install -y java-1.8.0-openjdk #atleast Java 8 is required, you may use other jre/jdk if you prefer
sudo rpm -i go-agent-${version}.noarch.rpm
Debian based distributions (ie Ubuntu)
The GoCD agent .deb installer has been tested on Ubuntu. However it should work on most Linux distributions which use debs.
If you prefer to use the APT repository and install via apt-get
, paste the following in your shell —
echo "deb https://download.gocd.org /" | sudo tee /etc/apt/sources.list.d/gocd.list
curl https://download.gocd.org/GOCD-GPG-KEY.asc | sudo apt-key add -
sudo apt-get update
Note: The GoCD server and agent require Java 8 to be installed.
sudo add-apt-repository ppa:openjdk-r/ppa
sudo apt-get update
sudo apt-get install -y openjdk-8-jre
Once you have the repository setup, execute
sudo apt-get install go-agent
Alternatively, if you have the agent DEB downloaded:
sudo dpkg -i go-agent-${version}.deb
Managing the go-agent service on linux
To manage the go-agent service, you may use the following commands -
sudo /etc/init.d/go-agent [start|stop|status|restart]
Configuring the go-agent
After installing the go-agent service, you must first configure the service with the hostname (or IP address) of your GoCD server, in order to do this -
- Open
/etc/default/go-agent
in your favourite text editor. - Change the IP address (127.0.0.1) in the line
GO_SERVER_URL=https://127.0.0.1:8154/go
to the hostname (or IP address) of your GoCD server. - Save the file and exit your editor.
- Run
/etc/init.d/go-agent [start|restart]
to (re)start the agent.
Note: You can override default environment for the GoCD agent by editing the file
/etc/defaults/go-agent
Location of GoCD agent files
The GoCD agent installs its files in the following locations on your filesystem:
/var/lib/go-agent #contains the binaries
/usr/share/go-agent #contains the start script
/var/log/go-agent #contains the agent logs
/etc/default/go-agent #contains all the environment variables with default values. These variable values can be changed as per requirement
Registering your agent with the server
For security reasons, all newly installed Go agents need to be enabled on the Go server before work is assigned to them. This prevents an unauthorized person from getting access to your source code. To enable a newly installed Go agent, do the following:
- Open the Go server dashboard
- Follow the instructions here to find the agent you've just installed on the list and add the agent to your cloud. The Go server will now schedule work for this agent.