Bamboo remote agent installation guide
はじめる前に
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 meet the minimum requirements?
See Supported platforms.
Do you have a supported version of Java installed on the agent machine?
See Supported platforms.
Are you upgrading your version of Bamboo?
- If you're upgrading Bamboo from version earlier than 6.10 to a version that's also earlier than 6.10, your remote agents will be upgraded automatically along with Bamboo.
If you're upgrading Bamboo from a release earlier than 6.10 to 6.10 or later, manually upgrade your remote agents to make sure that the Tanuki wrapper is also updated and the
wrapper.conffile is successfully recreated.Bamboo 6.10 comes with an updated Tanuki wrapper that fixes some known issues but is not updated automatically and must be reinstalled.
If you're upgrading Bamboo from a version earlier than 8.0 to 8.0 or later, and you are also upgrading the Java version on your Remote Agents from 8 to 11, you need to either update wrapper configuration manually or download a new Remote Agent JAR from your upgraded Bamboo and reinstall the wrapper.
Mixing Operating Systems between Bamboo Server and Remote Agents is supported and possible.
For example, you can connect a Linux based Remote Agent to a Windows Bamboo Server or a Windows Remote Agent to a Linux based Bamboo Server.
The only requirement is that it's running on a supported Operating System and Java version:
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
- From the Bamboo header select
> Build resources > Agents. - Select 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
- Create a directory on the agent machine (e.g.
bamboo-agent-home) to serve as the Bamboo agent home for the remote agent. - From the Bamboo header select > Build resources > Agents.
- The Agents screen displays showing the lists of all local agents and all remote agents that currently exist on your Bamboo system.
- If not already enabled, select the Enable remote agent support link.
- Select Install remote agent. The Installing a remote agent screen will display.
- Select DOWNLOAD Remote Agent JAR and save the JAR file to the directory on the agent machine that you created above.
- 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.
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.