This page describes how to install the Bamboo Remote Agent manually.
Bamboo remote agents are available only for Downloaded Bamboo - NOT for OnDemand Bamboo because of the OnDemand restrictions.
始める前に
- Not sure whether 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.
- Ensure that your system meets the system requirements. See Supported platforms.
- Ensure that you have a supported version of Java installed on the agent machine. See Supported platforms.
- Have you enabled the creation of remote agents, as described in Disabling and enabling remote agents support.
- Ensure that you have specified the Broker URL, as described in the Bamboo Setup Wizard and the Bamboo 2.0 Upgrade Guide.
- 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.
Step 1. 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. - On your Bamboo server, click Administration in the menu bar.
- Click Agents in the left panel. This will display the 'Agents' screen, showing lists of all local agents and all remote agents that currently exist on your Bamboo system.
- Click Enable Remote Agent Support, if necessary, and then Install Remote Agent.
- Click DOWNLOAD Remote Agent JAR and save the JAR file to the directory on the agent machine that you created in step 1.1.
- Take note of 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:
java -jar atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar http://bamboo-host-server:8085/agentServer/
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 to suppress the self-signed certificate of the server.
If you are having issues launching 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:
-Dbamboo.home=RemoteAgentHome
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:
java -Dbamboo.home=RemoteAgentHome -jar atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar http://bamboo-host-server:8085/agentServer/
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.
Disabling auto-capability detection for the remote agent
There may be situations where you want to prevent Bamboo from automatically detecting and adding capabilities (such as JDKs) to the remote agent, or where you don't want to run the remote agent with default capabilities.
To disable auto-capability detection for the remote agent, restart the agent with the following command line parameter before the JAR file name:
java -Ddisable_agent_auto_capability_detection=true -jar atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar http://bamboo-host-server:8085/agentServer/
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 https://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.
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:
Browse to:
http://<host>:8085/admin/agent/addRemoteAgent.action
- Click the the direct agent JAR is available at bamboo-agent-2.2.2.jar link and save 'classic' agent jar.
Start the agent with:
java -jar bamboo-agent-2.2.2.jar http://<host>:8085/agentServer/
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:
java -jar atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar http://bamboo-host-server:8085/agentServer <wrapper_command>
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 thewrapper.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.
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:
java -jar atlassian-bamboo-agent-installer-2.2-SNAPSHOT.jar http://bamboo-host-server:8085/agentServer <wrapper_command>
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.
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.
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 the Bamboo server, please this Troubleshooting Guide
Step 3. Configure the remote agent's capabilities
Please see Configuring 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.
35 Comments
MattS
Jul 25, 2008I want to run a remote agent at startup of a machine, and I see a suggestion to consult OS docs for that. It would be more helpful to provide examples for Linux and Windows as JIRA and Confluence do.
user-c7894
Jan 26, 2009Mac OSX 10.4+ users:
If you want to set up the Bamboo agent to automatically start up on a OSX system, create a file called com.atlassian.BambooAgent.plist in folder /Library/LaunchDaemons/ whose content is: (you need to edit the file to replace YOUR_BAMBOO_AGENT_HOME, YOUR_BAMBOO_SERVER, YOUR_LOG_FOLDER, USERNAME_TO_RUN_WITH with proper values for your installation)
Enjoy.
Anonymous
Mar 02, 2009Hi,
Is it possible to start the Bamboo server on OS X automatically a similar manner as you have described, I have done a brief search around atlassian but have not found anything so far.
Thanks!
Bernard Davison
Nov 22, 2011With Lion (MacOS X 10.7) I've found that the above plist didn't work with version 3.3.2. but it set me on the right track. The following works a treat however.
This also works for the Bamboo server.
Bob Swift
Oct 11, 2009Suggest you add to the documentation the ability for windows users to customize ...\conf\wrapper.conf file and that the ...\bin\InstallBambooAgent-NT.bat can be used after the customization. Running the remote agent jar will always replace the file, so this is the only way to customize it. For instance, you can run the remote agent jar command first so that the wrapper config gets created, remove the service, customize wrapper.conf, and then re-install the service with the wrapper command. For instance, this can customize the Windows service name.
user-9694f
Jul 08, 2010Hello all,
I used this page to help me download, install, and launch the new remote agent successfully but after 10-20 minutes the agent becomes unresponsive and goes offline.
Does anyone know why this would happen and how I can prevent this?
We had the same remote agent set up on a different server and it never went offline...
Although, the log does show that the old agent did get "marked as inactive". but a "new one came in place" so it never went offline...
marked as inactive. A new one came in place.
Jun 21, 2010 10:12:26 AM Remote agent "servername.domainname" came back after a period of inactivity.
Thanks for any help!
Giles Gaskell
Aug 09, 2010Hello Matthew,
My apologies for the delay in response. If this issue has not been addressed, then to get a speedier response, I would recommend either lodging a support ticket or posting a forum message via the links at the end of this page (below).
Kind regards,
Giles.
Anonymous
Aug 05, 2010How this guide applies to JIRA Studio?
I understand that when you use Bamboo server it is possible to push the button and download JAR file with the Bamboo agent installer. But how it can be done if I have Bamboo server integrated with JIRA Studio?
Thanks.
Giles Gaskell
Aug 09, 2010Hello there,
Please be aware that we do not support the integration of Bamboo remote agents with JIRA Studio.
Instead, if you need to expand the number of agents available to Bamboo in your JIRA Studio site, we recommend that you achieve this by expanding the number of Elastic Instances as indicated in Getting Started with Bamboo in JIRA Studio guide.
Best regards,
Giles.
Anonymous
Sept 15, 2010Hello, I 'm trying to run the remote agent as a service on a windows XP sp2 32 bits but still fails.
I installed it with
java -jar atlassian-bamboo-agent-installer-2.2.1.jar http://10.30.230.28:8085/agentServer/ installntservice
then I tried to run it with both the service.msc window and the command net start "Bamboo Remote Agent".
Both fails with
The Bamboo Remote Agent service is starting.....
The Bamboo Remote Agent service could not be started.
A system error has occurred.
System error 1067 has occurred.
The process terminated unexpectedly.
I also tried java -jar atlassian-bamboo-agent-installer-2.2.1.jar http://10.30.230.28:8085/agentServer/ start but then I got
STATUS | wrapper | 2010/09/15 17:43:42 | Starting the Bamboo Remote Agent service...
INFO | wrapper | 2010/09/15 17:43:47 | Waiting to start...
...
INFO | wrapper | 2010/09/15 17:45:04 | Waiting to start...
ERROR | wrapper | 2010/09/15 17:45:09 | The Bamboo Remote Agent service was launched, but failed to start.
Wrapper terminated with non zero exit code: 1
Destroying underlying agent process...
Anonymous
Jun 28, 2011I've just came across the same problem...Is anybody know how to solve it?
Windows XP is my non-bamboo-server PC.
Anonymous
Apr 04, 2012You should change the startup profile for the service. By default it runs from the SYSTEM and can not create necessary directories. Change the service startup profile to any existing admin account on the machine.
Mujahed
Jan 21, 2014I have installed Bamboo agent on windows 2008 server, and its going offline every time even if we run the services through the administrator.
INFO | jvm 7 | 2014/01/21 19:07:44 | at org.tanukisoftware.wrapper.WrapperSimpleApp.run(WrapperSimpleApp.java:240)
INFO | jvm 7 | 2014/01/21 19:07:44 | at java.lang.Thread.run(Thread.java:744)
INFO | jvm 7 | 2014/01/21 19:07:44 | Caused by: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
INFO | jvm 7 | 2014/01/21 19:07:44 | at sun.security.validator.PKIXValidator.doBuild(PKIXValidator.java:385)
INFO | jvm 7 | 2014/01/21 19:07:44 | at sun.security.validator.PKIXValidator.engineValidate(PKIXValidator.java:292)
INFO | jvm 7 | 2014/01/21 19:07:44 | at sun.security.validator.Validator.validate(Validator.java:260)
INFO | jvm 7 | 2014/01/21 19:07:44 | at sun.security.ssl.X509TrustManagerImpl.validate(X509TrustManagerImpl.java:326)
INFO | jvm 7 | 2014/01/21 19:07:44 | at sun.security.ssl.X509TrustManagerImpl.checkTrusted(X509TrustManagerImpl.java:231)
INFO | jvm 7 | 2014/01/21 19:07:44 | at sun.security.ssl.X509TrustManagerImpl.checkServerTrusted(X509TrustManagerImpl.java:126)
INFO | jvm 7 | 2014/01/21 19:07:44 | at sun.security.ssl.ClientHandshaker.serverCertificate(ClientHandshaker.java:1323)
INFO | jvm 7 | 2014/01/21 19:07:44 | ... 28 more
INFO | jvm 7 | 2014/01/21 19:07:44 | Caused by: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
INFO | jvm 7 | 2014/01/21 19:07:44 | at sun.security.provider.certpath.SunCertPathBuilder.engineBuild(SunCertPathBuilder.java:196)
INFO | jvm 7 | 2014/01/21 19:07:44 | at java.security.cert.CertPathBuilder.build(CertPathBuilder.java:268)
INFO | jvm 7 | 2014/01/21 19:07:44 | at sun.security.validator.PKIXValidator.doBuild(PKIXValidator.java:380)
INFO | jvm 7 | 2014/01/21 19:07:44 | ... 34 more
ERROR | wrapper | 2014/01/21 19:07:44 | JVM exited while starting the application.
FATAL | wrapper | 2014/01/21 19:07:44 | There were 5 failed launches in a row, each lasting less than 3 seconds. Giving up.
FATAL | wrapper | 2014/01/21 19:07:44 | There may be a configuration problem: please check the logs.
STATUS | wrapper | 2014/01/21 19:07:44 | <-- Wrapper Stopped
Anonymous
Dec 09, 2010Is a Bamboo remote agent what I need to run a Bamboo build on a PC other than the Bamboo server PC?
Anonymous
Dec 14, 2010yes
Chris Ferry
Sept 13, 2011Hey,
Why don't you provide an /etc/init.d bamboo remote agent script? Would be a nice thing to do don't you think?
In fact even better, provide apt and rpm packages.
That would be the right thing to do.
Anonymous
Dec 17, 2011Seconded.
Unknown User (br.bill)
Mar 26, 2013Thirded
Anonymous
Apr 26, 2013Couldn't agree more
Anonymous
Jun 22, 2012Could not get it started - it fails due to java.lang.NumberFormatException
INFO | jvm 1 | 2012/06/22 01:35:29 | ---- Debugging information ----
INFO | jvm 1 | 2012/06/22 01:35:29 | message : For input string: "2012-06-22 08:29:48.186 UTC"
INFO | jvm 1 | 2012/06/22 01:35:29 | cause-exception : java.lang.NumberFormatException
INFO | jvm 1 | 2012/06/22 01:35:29 | cause-message : For input string: "2012-06-22 08:29:48.186 UTC"
INFO | jvm 1 | 2012/06/22 01:35:29 | class : java.util.Date
INFO | jvm 1 | 2012/06/22 01:35:29 | required-type : java.util.Date
INFO | jvm 1 | 2012/06/22 01:35:29 | converter-type : com.thoughtworks.xstream.converters.SingleValueConverterWrapper
INFO | jvm 1 | 2012/06/22 01:35:29 | wrapped-converter : com.atlassian.bamboo.persister.xstream.SecondsDateConverter
INFO | jvm 1 | 2012/06/22 01:35:29 | path : /result/value/creationDate
INFO | jvm 1 | 2012/06/22 01:35:29 | line number : 4
INFO | jvm 1 | 2012/06/22 01:35:29 | class[1] : com.atlassian.bamboo.v2.build.agent.RemoteAgentDefinitionImpl
INFO | jvm 1 | 2012/06/22 01:35:29 | converter-type[1] : com.thoughtworks.xstream.converters.reflection.ReflectionConverter
INFO | jvm 1 | 2012/06/22 01:35:29 | class[2] : org.springframework.remoting.support.RemoteInvocationResult
INFO | jvm 1 | 2012/06/22 01:35:29 | version : null
Anonymous
Jul 02, 2012Is there any way to preconfigure build-dir? (Windows)
Kyle O'Connor
Aug 08, 2012If I set custom JVM sizings in the wrapper.conf, does this apply to just the agent process itself, or to the builds that will run on it?
Gili
Sept 16, 2012To auto-start under Ubuntu, do the following:
That's it. The remote agent will now start up on boot.
These instructions are based on: http://ubuntuforums.org/showthread.php?t=1689525
Anonymous
Oct 19, 2012I'm currently trying to evaluate the tool but i'm stuck with this error. The remote client can't start.
[WrapperSimpleAppMain] [AgentContext] Bootstrap Type: 'REMOTE'
INFO | jvm 1 | 2012/10/19 14:43:16 | 2012-10-19 14:43:16,612 INFO [Thread-1] [RemoteAgent] com.atlassian.bamboo.v2.build.agent.remote.RemoteAgent starting.
INFO | jvm 1 | 2012/10/19 14:43:16 | 2012-10-19 14:43:16,722 INFO [Thread-1] [RemoteAgentHomeLocatorForBootstrap] Agent home located at 'C:\Documents and Settings\svnbuild\bamboo-agent-home'
INFO | jvm 1 | 2012/10/19 14:43:16 | 2012-10-19 14:43:16,737 INFO [Thread-1] [RemoteAgent] Starting Bamboo Remote Agent...
INFO | jvm 1 | 2012/10/19 14:43:16 | 2012-10-19 14:43:16,737 INFO [Thread-1] [RemoteAgent] Starting application context...
INFO | jvm 1 | 2012/10/19 14:43:17 | 2012-10-19 14:43:17,753 WARN [Thread-1] [PropertyPlaceholderConfigurer] Could not load properties from class path resource [bamboo-init.properties]: class path resource [bamboo-init.properties] cannot be opened because it does not exist
INFO | jvm 1 | 2012/10/19 14:43:17 | 2012-10-19 14:43:17,784 INFO [Thread-1] [RemoteAgentHomeLocatorForBootstrap] Agent home located at 'C:\Documents and Settings\svnbuild\bamboo-agent-home'
INFO | jvm 1 | 2012/10/19 14:43:17 | 2012-10-19 14:43:17,784 INFO [Thread-1] [RemoteAgentHomeDirectoryLayout] Plugin directory: C:\Documents and Settings\svnbuild\bamboo-agent-home\plugins
INFO | jvm 1 | 2012/10/19 14:43:17 | 2012-10-19 14:43:17,784 INFO [Thread-1] [RemoteAgentHomeDirectoryLayout] Plugin cache directory: C:\Documents and Settings\svnbuild\bamboo-agent-home\caches\plugins
INFO | jvm 1 | 2012/10/19 14:43:17 | 2012-10-19 14:43:17,816 WARN [Thread-1] [AgentConfiguration] Configuration file does not exist. Creating File: bamboo-agent.cfg.xml
INFO | jvm 1 | 2012/10/19 14:43:17 | 2012-10-19 14:43:17,831 INFO [Thread-1] [AgentUuidInitializer] Found agent UUID '1e9eca0a-6c06-4ba6-9009-691640ec2447' in temporary UUID file 'C:\Documents and Settings\svnbuild\bamboo-agent-home\uuid-temp.properties'
INFO | jvm 1 | 2012/10/19 14:43:17 | 2012-10-19 14:43:17,831 INFO [Thread-1] [AgentConfiguration] Setting UUID in main config file to '1e9eca0a-6c06-4ba6-9009-691640ec2447'
INFO | jvm 1 | 2012/10/19 14:43:17 | 2012-10-19 14:43:17,862 INFO [Thread-1] [BambooActiveMQConnectionFactory] Setting broker URL to 'failover:(tcp://atc-bamboo1:54663?wireFormat.maxInactivityDuration=300000)?maxReconnectAttempts=10&initialReconnectDelay=15000'
INFO | jvm 1 | 2012/10/19 14:43:17 | 2012-10-19 14:43:17,956 INFO [Thread-1] [BambooActiveMQConnectionFactory] Setting broker URL to 'failover:(tcp://atc-bamboo1:54663?wireFormat.maxInactivityDuration=300000)?maxReconnectAttempts=10&initialReconnectDelay=15000'
Anonymous
Oct 21, 2012Same problem for me as with the previous comment. I cannot get the remote client working on Mac.
Anonymous
Jan 10, 2013Is there a way to automatically rename the bamboo agent at installation?
Anonymous
Mar 11, 2013I need instruction on how to configure autostart of bamboo agent on Centos x64
Anonymous
Jul 12, 2013You need to create an init script for this.
Anonymous
Jun 04, 2013Hi,
I used the method describe above to install the bamboo agent on Mac OSX and start it as daemon. But I would like to set up a custom PATH for the bamboo agent so some of the tools installed get precedence over the default Mac OSX ones. I am wondering where is the best place to insert the custom PATH variable. In the plist file for the launch daemon or in the conf xml file in bamboo home? Any help is appreciated.
Thanks in advance
Mg12
Jul 01, 2013Step 1. Download and install the remote agent
bamboo-agent-home
) to serve as the Bamboo agent home for the remote agent.There is no menu called Administration. Presumably you mean Bamboo Admin.
There is no link called Agents. Presumably you mean Agent Matrix.
There is nothing called Enable Remote Agent Support
There is nothing to download
Roman Shamritskiy
Dec 03, 2013Mg12, I use Bamboo OnDemand and have the same problems. Did you manage to solve them?
Przemek Bruski
Dec 03, 2013Remote agents are not supported on OnDemand. This feature request is tracked here: BAM-11870 - Getting issue details... STATUS . Please comment and vote.
Anonymous
Jul 12, 2013Suppressing the self-signed certificate of the server
You might want to change the URL in the example to https://
Anonymous
Dec 04, 2013how to add bamboo-agent start-up service in mac os. If bamboo-agent is reboot, then it will automatically start on boot time.
ArmenA
Dec 04, 2013You can follow the recommendations from this page - Configuring Bamboo to start automatically on startup on Mac OS X