The buildkite agent is a small, reliable and cross-platform build runner that makes it easy to run automated builds on your own infrastructure. Its main responsibilities are polling buildkite.com for work, running build jobs, reporting back the status code and output log of the job, and uploading the job's artifacts.
This custom image is based on the docker:dind to provide docker-in-docker alongside Buildkite to support the automated integration cases run for Authelia's CI process.
The image will be re-built if any updates are made to the base docker:dind image.
This image shamelessly utilises some of the fine work by the team over at LinuxServer.io, credits to their alpine baseimage.
Here are some example snippets to help you get started creating a container.
An example docker-compose.yml has also been provided in the repo which includes three nodes and a local registry cache.
docker create \
--name=buildkite1 \
-e BUILDKITE_AGENT_NAME=named-node-1 \
-e BUILDKITE_AGENT_TOKEN=tokenhere \
-e BUILDKITE_AGENT_TAGS=tags=here,moretags=here \
-e BUILDKITE_AGENT_PRIORITY=priorityhere \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Australia/Melbourne \
-v <path to data>/ssh:/buildkite/.ssh \
-v <path to data>/bundle:/buildkite/.bundle \
-v <path to data>/cache:/buildkite/.cache \
-v <path to data>/gem:/buildkite/.gem \
-v <path to data>/go:/buildkite/.go \
-v <path to data>/hooks:/buildkite/hooks \
--restart unless-stopped \
--privileged \
authelia/buildkite
Compatible with docker-compose v2 schemas.
---
version: "2.1"
services:
buildkite1:
image: authelia/buildkite
container_name: buildkite1
privileged: true
volumes:
- <path to data>/ssh:/buildkite/.ssh \
- <path to data>/bundle:/buildkite/.bundle \
- <path to data>/cache:/buildkite/.cache \
- <path to data>/gem:/buildkite/.gem \
- <path to data>/go:/buildkite/.go \
- <path to data>/hooks:/buildkite/hooks
restart: unless-stopped
environment:
- BUILDKITE_AGENT_NAME=named-node-1
- BUILDKITE_AGENT_TOKEN=tokenhere
- BUILDKITE_AGENT_TAGS=tags=here,moretags=here
- BUILDKITE_AGENT_PRIORITY=priorityhere
- PUID=1000
- PGID=1000
- TZ=Australia/Melbourne
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
| Parameter | Function |
|---|---|
-e BUILDKITE_AGENT_NAME=named-node-1 |
agent name for buildkite agent on specified node |
-e BUILDKITE_AGENT_TOKEN=tokenhere |
agent token for specified pipeline |
-e BUILDKITE_AGENT_TAGS=tags=here,moretags=here |
agent tags on specified node, tag=value comma separated |
-e BUILDKITE_AGENT_PRIORITY=1 |
agent priority |
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-e TZ=Australia/Melbourne |
for setting timezone information, eg Australia/Melbourne |
-v /buildkite/.ssh |
SSH id_rsa and ida_rsa.pub stored here for GitHub cloning |
-v /buildkite/.bundle |
$BUNDLE_PATH, set this location to share cache between multiple node containers |
-v /buildkite/.cache |
$YARN_CACHE_FOLDER, set this location to share cache between multiple node containers |
-v /buildkite/.gem |
$GEM_HOME, set this location to share cache between multiple node containers |
-v /buildkite/.go |
$GOPATH, set this location to share cache between multiple node containers |
-v /buildkite/hooks |
Directory used to provide agent based hooks /buildkite/hooks/environment is used to provide secrets in to Buildkite such as DOCKER_USERNAME DOCKER_PASSWORD and GITHUB_TOKEN for publish and clean up steps |
When using volumes (-v flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
- 18/11/2020: Include nyc package for frontend coverage
- 10/11/2020: Update golangci-lint to v1.32.2
- 26/10/2020: Update s6 and reviewdog to v2.1.0.2 and v0.11.0 respectively
- 19/10/2020: Update buildkite-agent to v3.24.0
- 19/10/2020: Update s6 to v2.1.0.0
- 15/09/2020: Update golangci-lint to v1.31.0
- 15/09/2020: Update buildkite-agent to v3.23.1
- 06/09/2020: Update buildkite-agent to v3.23.0
- 03/09/2020: Update golangci-lint and reviewdog to v1.30.0 and v0.10.2 respectively
- 24/07/2020: Update golangci-lint to v1.29.0
- 13/07/2020: Update golangci-lint to v1.28.3
- 30/06/2020: Update reviewdog to v0.10.1
- 19/06/2020: Update buildkite-agent to v3.22.1
- 02/06/2020: Include gnu variant of find
- 15/05/2020: Update buildkite-agent to v3.22.0
- 14/05/2020: Update golangci-lint to v1.27.0
- 08/05/2020: Update reviewdog to v0.10.0
- 08/05/2020: Update buildkite-agent to v3.21.1
- 05/05/2020: Update buildkite-agent to v3.21.0
- 02/05/2020: Update golangci-lint to v1.26.0
- 28/04/2020: Update golangci-lint to v1.25.1
- 23/04/2020: Update golangci-lint to v1.25.0
- 06/04/2020: Include golangci-lint and reviewdog
- 02/04/2020: Update chromium and chromedriver to 80.0.3987.132-r2
- 10/03/2020: Set $BUNDLE_PATH for ruby
- 09/03/2020: Include gnu variant of sed
- 28/02/2020: Include ruby and bundler to generate doc website with Jekyll
- 12/02/2020: Update buildkite-agent to v3.20.0
- 30/01/2020: Update buildkite-agent to v3.19.0
- 29/01/2020: Update buildkite-agent to v3.18.0
- 15/01/2020: Include
/buildkite/hooks/environmentexample and clarify hooks explanation - 07/01/2020: Pin chromium and chromedriver to 77.0.3865.120-r0
- 07/01/2020: Include tar and zstd packages
- 19/12/2019: Initial release