Skip to content

Atlassian Bamboo Bamboo Agent

Overview

A Bamboo Agent is a service that can run job builds. Each agent has a defined set of capabilities and can run builds only for jobs whose requirements match the agent's capabilities.

If you are looking for Bamboo Docker Image it can be found here. To learn more about Bamboo, see: https://www.atlassian.com/software/bamboo

This Docker container makes it easy to get a Bamboo Remote Agent up and running. It is intended to be used as a base to build from, and as such contains limited built-in capabilities:

  • JDK 11 (JDK 17 starting from v9.4.0)
  • Git & Git LFS
  • Maven 3
  • Python 3

Using this image as a base, you can create a custom remote agent image with your desired build tools installed. Note that Bamboo Agent Docker Image does not include a Bamboo server.

Use docker version >= 20.10.9.

Quick Start

For the BAMBOO_HOME directory that is used to store the repository data (amongst other things) we recommend mounting a host directory as a data volume, or via a named volume.

To get started you can use a data volume, or named volumes. In this example we'll use named volumes.

Run an Agent: 

docker volume create --name bambooAgentVolume
docker run -e BAMBOO_SERVER=http://bamboo.mycompany.com/agentServer/ -v bambooVolume:/var/atlassian/application-data/bamboo --name="bambooAgent" --hostname="bambooAgent" -d atlassian/bamboo-agent-base

The Bamboo remote agent is now available to be approved in your Bamboo administration.

Verbose container entrypoint logging

During the startup process of the container, various operations and checks are performed to ensure that the application is configured correctly and ready to run. To help in troubleshooting and to provide transparency into this process, you can enable verbose logging. The VERBOSE_LOGS environment variable enables detailed debug messages to the container's log, offering insights into the actions performed by the entrypoint script.

  • VERBOSE_LOGS (default: false)

Set to true to enable detailed debug messages during the container initialization.

Configuration

  • BAMBOO_SERVER (required)

The URL of the Bamboo Server the remote agent should connect to, e.g. http://bamboo.mycompany.com/agentServer/

  • SECURITY_TOKEN (default: NONE)

If security token verification is enabled, this value specifies the token required to authenticate to the Bamboo server

  • WRAPPER_JAVA_INITMEMORY (default: 256)

The minimum heap size of the JVM. This value is in MB and should be specified as an integer

  • WRAPPER_JAVA_MAXMEMORY (default: 512)

The maximum heap size of the JVM. This value is in MB and should be specified as an integer

  • IGNORE_SERVER_CERT_NAME (default: false)

Ignore SSL certificate hostname if it's issued to a different host than the one under your Bamboo Base URL hostname

  • ALLOW_EMPTY_ARTIFACTS (default: false)

Allow empty directories to be published as artifacts

  • BAMBOO_AGENT_PERMISSIVE_READINESS (default: unset/false)

If set to 'true', the readiness probe will be more permissive and not expect the agent to be fully configured, only that the startup wrapper is running. This is primarily intended for use when deploying agents into environments where the server may not yet be configured.

  • BAMBOO_AGENT_CLASSPATH_DIR (default: NONE)

If set, agent startup process will copy agent classpath from designated location instead of downloading it from the server. This can speed up the process and reduce the load on the Bamboo server.

Dedicated agent specific configuration

  • AGENT_EPHEMERAL_FOR_KEY (default: NONE)

The value specifies the purpose for spawning the agent. It needs to be a valid ResultKey.

  • KUBE_NUM_EXTRA_CONTAINERS (default: 0)

The number of extra containers that run in parallel with the Bamboo Agent. We make sure these extra containers are run before the Agent kick in.

  • EXTRA_CONTAINERS_REGISTRATION_DIRECTORY (default: /pbc/kube)

The directory where extra containers should register their readiness by creating any file. The image waits for having KUBE_NUM_EXTRA_CONTAINERS number of files inside this directory (if the one exists) before processing further and running the actual agent.

Ephemeral agent specific configuration

  • BAMBOO_EPHEMERAL_AGENT_DATA (default: NONE)

The Bamboo Ephemeral Agents specific configuration. It was designed to pass multiple key-value properties separated by the #. Example: BAMBOO_SERVER=http://localhost#SECURITY_TOKEN=123456789#bamboo.agent.ephemeral.for.key=PROJ-PLAN-JOB1-1

Additional agent wrapper properties

  • BAMBOO_WRAPPER_JAVA_ADDITIONAL_PROPERTIES (default: NONE)

Adds wrapper.java.additional.X entries to the Agent's conf/wrapper.conf. It was designed to pass multiple key-value properties separated by the #. Example: log4j2.configurationFile=/path/to/log4j2.properties#javax.net.ssl.keyStore=/var/atlassian/application-data/bamboo-agent/ssl/bamboo.secure.client.ks

Extending base image

This Docker image contains only minimal setup to run a Bamboo agent which might not be sufficient to run your builds. If you need additional capabilities you can extend the image to suit your needs.

Example of extending the agent base image by Maven and Git: 

FROM atlassian/bamboo-agent-base:8.2.1
USER root
RUN apt-get update && \
    apt-get install maven -y && \
    apt-get install git -y

USER ${BAMBOO_USER}
RUN /bamboo-update-capability.sh "system.builder.mvn3.Maven 3.3" /usr/share/maven
RUN /bamboo-update-capability.sh "system.git.executable" /usr/bin/git

Building your own image

  • Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-bamboo-agent-base/
  • Modify or replace the Jinja templates under config; NOTE: The files must have the .j2 extensions. However you don't have to use template variables if you don't wish.
  • Build the new image with e.g: docker build --build-arg BAMBOO_VERSION=X.Y.Z --tag my-agent-image .
  • Optionally push to a registry, and deploy.

Issue tracker

  • You can view know issues here.
  • Please contact our support if you encounter any problems with this Dockerfile.

Supported JDK versions

Bamboo agent images are based on JDK 11, and generated from the official Eclipse Temurin OpenJDK Docker images. Starting from Bamboo 9.4 images are built on top of JDK 17.

Starting from 9.4 UBI based tags are published as well. UBI tags are available in 2 formats: <version>-ubi9 and <version>-ubi9-jdk17.

The Docker images follow the Atlassian Support end-of-life policy; images for unsupported versions of the products remain available but will no longer receive updates or fixes.

However, Bamboo is an exception to this. Due to the need to support JDK 11 and Kubernetes, we currently only generate new images for Bamboo 8.0 and up. Legacy builds for JDK 8 are still available in Docker Hub, and building custom images is available (see above).

Historically, we have also generated other versions of the images, including JDK 8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in Docker Hub, however they should be considered deprecated, and do not receive updates or fixes.

If for some reason you need a different version, see "Building your own image".

Migration to UBI

If you have been mounting any files to ${JAVA_HOME} directory in eclipse-temurin based container, JAVA_HOME in UBI JDK17 container is set to /usr/lib/jvm/java-17.

Also, if you have been mounting and running any custom scripts in the container, UBI-based images may lack some tools and utilities that are available out of the box in eclipse-temurin tags. If that's the case, see Building your own image.

Support

For product support, go to support.atlassian.com

You can also visit the Atlassian Data Center forum for discussion on running Atlassian Data Center products in containers.