GoCD Agent Docker image

GoCD agent docker image based on docker dind.

Issues, feedback?

Please make sure to log them at https://github.com/gocd/gocd.

Usage

Start the container with this:

docker run --privileged -d -e GO_SERVER_URL=... gocd/gocd-agent-docker-dind:v22.3.0

Note: Please make sure to always provide the version. We do not publish the latest tag. And we don't intend to.

This will start the GoCD agent and connect it the GoCD server specified by GO_SERVER_URL.

Note: The GO_SERVER_URL must be an HTTPS url and end with /go, for e.g. http://ip.add.re.ss:8153/go

Usage with docker GoCD server

If you have a gocd-server container running and it's named angry_feynman, you can connect a gocd-agent container to it by doing:

docker run --privileged -d -e GO_SERVER_URL=http://$(docker inspect --format='{{(index (index .NetworkSettings.IPAddress))}}' angry_feynman):8153/go gocd/gocd-agent-docker-dind:v22.3.0

OR

If the docker container running the GoCD server has ports mapped to the host,

docker run --privileged -d -e GO_SERVER_URL=http://<ip_of_host_machine>:$(docker inspect --format='{{(index (index .NetworkSettings.Ports "8153/tcp") 0).HostPort}}' angry_feynman)/go gocd/gocd-agent-docker-dind:v22.3.0

Available configuration options

Auto-registering the agents

docker run --privileged -d \
        -e AGENT_AUTO_REGISTER_KEY=... \
        -e AGENT_AUTO_REGISTER_RESOURCES=... \
        -e AGENT_AUTO_REGISTER_ENVIRONMENTS=... \
        -e AGENT_AUTO_REGISTER_HOSTNAME=... \
        gocd/gocd-agent-docker-dind:v22.3.0

If the AGENT_AUTO_REGISTER_* variables are provided (we recommend that you do), then the agent will be automatically approved by the server. See the auto registration docs on the GoCD website.

Configuring SSL

To configure SSL parameters, pass the parameters using the environment variable AGENT_BOOTSTRAPPER_ARGS. See this documentation for supported options.

    docker run --privileged -d \
    -e AGENT_BOOTSTRAPPER_ARGS='-sslVerificationMode NONE ...' \
    gocd/gocd-agent-docker-dind:v22.3.0

Mounting volumes

The GoCD agent will store all configuration, logs and perform builds in /godata. If you'd like to provide secure credentials like SSH private keys among other things, you can mount /home/go.

docker run --privileged -v /path/to/godata:/godata -v /path/to/home-dir:/home/go gocd/gocd-agent-docker-dind:v22.3.0

Note: Ensure that /path/to/home-dir and /path/to/godata is accessible by the go user in container (go user - uid 1000).

Tweaking JVM options (memory, heap etc)

JVM options can be tweaked using the environment variable GOCD_AGENT_JVM_OPTS.

docker run --privileged -e GOCD_AGENT_JVM_OPTS="-Dfoo=bar" gocd/gocd-agent-docker-dind:v22.3.0

Under the hood

The GoCD server runs as the go user, the location of the various directories is:

Directory	Description
/godata/config	the directory where the GoCD configuration is stored
/godata/pipelines	the directory where the agent will run builds
/godata/logs	the directory where GoCD logs will be written out to
/home/go	the home directory for the GoCD server

Running GoCD Containers as Non Root

With release v19.6.0, GoCD containers will run as non-root user, by default. The Dockerized GoCD application will run with user go (uid: 1000) and group root (gid: 0) instead of running as user root (uid: 0) and group root (gid: 0). For more information, checkout Running Dockerized GoCD Containers as Non Root blog post.

Troubleshooting

The GoCD agent does not connect to the server

• Check if the docker container is running docker ps -a
• Check the STDOUT to see if there is any output that indicates failures docker logs CONTAINER_ID
• Check the agent logs docker exec -it CONTAINER_ID /bin/bash, then run less /godata/logs/*.log inside the container.

License

Copyright 2022 Thoughtworks, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.