All Versions

   Bamboo 5.0.x
   Bamboo 4.4.x
   Bamboo 4.3.x
   Bamboo 4.2.x  
   More... 

Bamboo 3.3 Documentation

Index
Downloads (PDF, HTML & XML formats)

This documentation relates to an earlier version of Bamboo.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata

This page describes how to install the Bamboo Remote Agent manually.

Before you begin:

  • Ensure that you have Java Runtime Environment 5.0 or later installed on the agent machine.
  • Have you implemented your own remote agent service wrapper? You may not want to use the remote agent supervisor that is bundled with the remote agent. You can choose to install the legacy remote agent (pre-Bamboo 2.2) instead, which does not have a service wrapper.

On this page:

Step 1. 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. On your Bamboo server, click the 'Administration' link in the top navigation bar.
  3. Click the 'Agents' link in the left navigation column.
  4. This will display the 'Agents' screen, showing lists of all Local Agents and all Remote Agents that currently exist in your Bamboo system.
  5. Click the 'Install Remote Agent' link. The following screen will be displayed:

    Screenshot above: Installing a remote agent
  6. Click the 'DOWNLOAD Remote Agent JAR' button and save the JAR file to the directory you created in step 1.1.
  7. Note the command under the heading 'Running a Remote Agent' for use in step 2 below.

Step 2. Launch the Remote Agent

Once installed, you can run the remote agent by executing the command line obtained in the previous step. This command will look something like the following:

(info) The name of the jar file (e.g. atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar) will vary depending on the version of Bamboo you are running.

You can also choose to run the remote agent with different command line parameters, to change where the remote agent stores its data or suppress the self-signed certificate of the server.

Icon

If you are having issues bringing up the Agent, then take a look at our troubleshooting guide.

Changing where the remote agent stores its data

 

By default, the remote agent will store its data in a USER_HOME/bamboo-agent-home. If you wish to specify a different directory, add the following command line parameter before the JAR file name:

where RemoteAgentHome is the path to the Bamboo agent home directory you created in step 1.1.
Your command line will look something like this:

(info) The name of the jar file (e.g. atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar) will vary depending on the version of Bamboo you are running.

Changing the logging on the remote agent

 

By default, the remote agent will use the same logging level as the Bamboo server. However, you can control the level of logging of your remote agent independently of your Bamboo server by setting up a separate logging configuration file.

Please see Logging in Bamboo for further details.

Suppressing the self-signed certificate of the server

 

If your Bamboo server uses SSL (https) with a self-signed certificate, you will need to carry out one of the following two options:

  • Add the following parameter "-Dbamboo.agent.ignoreServerCertName=true" to the remote agent's command line, for example:
    java -Dbamboo.agent.ignoreServerCertName=true -jar atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar http://bamboo-host-server:8085/agentServer/
    Please be aware that this reduces the security of your configuration, as the identity of your Bamboo server will not be authenticated by the remote agent.
  • Use the keytool utility to add the self-signed certificate to the trusted certificates in your keystore. This is a more secure option, but is complex to set up. For detailed instructions of how to do this, please refer to the relevant Sun documentation.

Running Bamboo without the Remote Agent Supervisor

 

The remote agent supervisor is included in the remote agent JAR bundled with Bamboo. The appropriate remote agent supervisor for the operating system of your remote machine, will be automatically installed when you run the default remote agent start-up command line.

Icon

The remote agent supervisor cannot be installed on a small number of operating systems (i.e. the remote agent will start without the remote agent supervisor). If the remote agent supervisor fails to install, please check the operated systems list on the remote agent supervisor page. If your operating system is on the list and the remote agent supervisor still fails to install, please raise a support request in the Bamboo project.

If you need to run the remote agent without running the remote agent supervisor, you can execute the 'classic' version of the remote agent JAR.
The 'classic' agent jar is available from bamboo's agent installation page for download. Follow the steps below to run the 'classic' version of the remote agent:

  1. Browse to

  2. Click the 'the direct agent JAR is available at bamboo-agent-2.2.2.jar.' link and save 'classic' agent jar.
  3. Start the agent with

(info) The name of the jar file (e.g. bamboo-agent-2.2.2.jar) will vary depending on the version of Bamboo you are running.

Running the remote agent with different start-up commands

 

The remote agent supervisor is executed by default when you run the default remote agent start-up command line. The remote agent supervisor is implemented via a Java Service wrapper. The wrapper allows you to execute a number of general start-up commands when the remote agent is run. These commands are appended to the end of the default remote agent start-up command line,
i.e.

where <wrapper_command> is one of the keywords described below:

  • console — runs the remote agent in the foreground, i.e. display all of the commands on the screen. The agent home directory will be populated only if it is empty. This parameter is used by default.
  • start — runs the remote agent in the background, i.e. no commands are displayed on screen. If you have installed the remote agent as a Windows service, this command will work with the service.
  • stop — stops a remote agent that is running. If you have installed the remote agent as a Windows service, this command will work with the service.
  • status(non-Windows OS only) returns the status of the remote agent, e.g. "Remote agent is not running."
  • install — installs the files for the remote agent, but does not start it. This will overwrite any changes that have been made to the wrapper.conf file. The agent home directory will be populated, regardless of whether it is empty or not, i.e. existing files will be overwritten. You may wish to use this option, if you want to customise the remote agent files before starting it.

(info) The name of the jar file (e.g. atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar) will vary depending on the version of Bamboo you are running.

(Windows only) Installing the remote agent as a Windows service

 

The remote agent supervisor is executed by default when you run the default remote agent start-up command line. The remote agent supervisor is implemented via a Java Service wrapper. The wrapper allows you to install or uninstall the remote agent as a service in Windows (i.e. start the Bamboo remote agent automatically when the machine boots). This is done by appending the appropriate wrapper commands to the end of the default remote agent start-up command line,
i.e.

where <wrapper_command> is one of the keywords described below:

  • installntservice(Windows only) installs the remote agent as a Windows service.
  • uninstallntservice(Windows only) uninstalls the remote agent as a Windows service.

(info) The name of the jar file (e.g. atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar) will vary depending on the version of Bamboo you are running.

If you have installed the NT service, you will be able to use the start and stop start-up console commands with the service.

Icon

The remote agents connect to the Bamboo server on the normal http/https port and 54663. You need to ensure that, the network firewall isn't blocking these ports.

If you're having issues connecting the Remote Agent with Server, please this Troubleshooting Guide

 

Step 3. Configure the Remote Agent's Capabilities

Step 4. (Optional) Rename the Remote Agent

Your new remote agent has been automatically given a default name (e.g. 'Remote Agent on mymachine'). If you wish to rename your new remote agent, please see Editing an Agent's Details.