Bamboo remote agent installation guide

Before you begin

Before you begin installing remote agents, there are a few questions you need to answer. 

 

Do you need to install a remote agent?

See Agents and capabilities to understand how remote agents interact with your Bamboo server.

Do you have sufficient agent licenses? See Bamboo licensing for details.
Does your system meets the minimum requirements? See Supported platforms.
Do you have a supported version of Java installed on the agent machine See Supported platforms.

Note that you can run multiple Bamboo agents on the same machine – you just need to provide a separate home directory for each agent installation.

1. Enable remote agent support

  1. Click the  icon in the Bamboo header and choose  Overview.
  2. In the left-hand panel, under Build Resources, click Agents.
  3. Click either Enable Remote Agent Support or Disable Remote Agent Support.

Read more about enabling and disabling remote agent support here.


 2. Download and install the remote agent

  1. Create a directory on the agent machine (e.g. bamboo-agent-home) to serve as the Bamboo agent home for the remote agent.
  2. Click the  icon in the Bamboo header and choose  Overview.
  3. In the left-hand panel, under Build Resource, click Agents in the left panel.
    The 'Agents' screen displays showing the lists of all local agents and all remote agents that currently exist on your Bamboo system.
  4. If not already enabled, click the Enable remote agent support link 
  5. Click Install Remote Agent. The 'Installing a remote agent' screen will display
  6. Click DOWNLOAD Remote Agent JAR and save the JAR file to the directory on the agent machine that you created above.
  7. Copy the command under 'Running a Remote Agent' to the clipboard for use in Step 3 that follows.

3. Launch the remote agent

Once installed, run the remote agent by executing the command line obtained above. This command will look something like this:

java -jar atlassian-bamboo-agent-installer-X.X-SNAPSHOT.jar http://bamboo-host-server:8085/bamboo/agentServer/

Where X.X represents your Bamboo version number.

If you are having issues launching the agent, then take a look at our troubleshooting guide.

 

 

(info) The name of the jar file, for example, atlassian-bamboo-agent-installer-5.4-SNAPSHOT.jar, will vary depending on the version of Bamboo you are running.

You can run the remote agent with a number of additional command line parameters. Configuration options include remote agent data storage, capability detection and logging, suppression of self-signed certificate and running without the Remote Agent Supervisor or with different start-up commands.

See Additional remote agent options for more information.

4. Configure the remote agent's capabilities

All remote agents feature a capability that can be defined. Examples include an executable, such as Maven, a JDK, a DVCS client or a custom capability. They typically define the path to an executable that has already been installed, and must be defined in Bamboo before Bamboo or its agents can make use of them.

Capabilities can be defined specifically for an agent, or shared between all local or all remote agents.

See Configuring capabilities for more on defining capabilities.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport