How to install multiple Bamboo remote agents on Windows machine


Platform notice: Server and Data Center only. This article only applies to Atlassian products on the Server and Data Center platforms.

Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

Summary

This article shows specific commands and step-by step procedure to install multiple(more than 1) Remote Agents on a single Window Machine.
This can also be used in case the Default Windows Service name(i.e bamboo-remote-agent) for the Bamboo remote agent needs to to be modified.

Caution: Note that you can run multiple Bamboo agents on the same machine. However, make sure the agent capabilities (ex: Maven, Gradle, Ant, etc) are isolated to avoid any race condition which may occur. Seprate users can be used to run the agent service on same host.


Environment

All supported Bamboo versions.

Solution

When installing Bamboo Remote Agent on Windows Machine the default installation command for Windows OS installs the application in the path C:\Users\<user-name>\bamboo-agent-home and creates a windows service with service name bamboo-remote-agent and  display name Bamboo Remote Agent. While this is not an issue while running a single remote agent on windows machine, but would require additional steps and configuration changes to successfully install multiple remote agents.

Use the below commands and steps to install multiple remote agent on Windows OS:

1) Install Remote Agent 1

  • Use the below command to install the the first remote agent. This command will download and install all the files in the mentioned path but will not create any windows service yet.
		// To install 1st agent:
		java -jar -Dbamboo.home=C:\path\to\atlassian-bamboo-agent1 atlassian-bamboo-agent-installer-X.X.X.jar http://<Bamboo-URL>/agentServer/ install


  • You can then see remote agent files are dowloaded in the above path C:\path\to\atlassian-bamboo-agent1 as provided in the command.
  •  Locate C:\path\to\atlassian-bamboo-agent1\conf\wrapper.conf and change the name of below 2 parameters as below and save the file.
		# Name of the service
		wrapper.name=bamboo-remote-agent-1

		# Display name of the service
		wrapper.displayname=Bamboo Remote Agent 1


  • Locate C:\path\to\atlassian-bamboo-agent1\bin directory and execute the bat file InstallBambooAgent-NT.bat . This will create the first remote agent service named Bamboo Remote Agent 1 but the service will be in stopped state.
  • In the Windows Run terminal type services.msc to open the windows services console. Locate the Bamboo Remote Agent 1 and start the service.

2) Install Remote Agent 2

  • Use the below command to install the the second remote agent. This command command will download and install all the files in the mentioned path but will not create any windows service yet.
		// To install 2nd agent:
		java -jar -Dbamboo.home=C:\path\to\atlassian-bamboo-agent2 atlassian-bamboo-agent-installer-X.X.X.jar http://<Bamboo-URL>/agentServer/ install


  • You can then see remote agent files are dowloaded in the above path C:\path\to\atlassian-bamboo-agent2 as provided in the command.
  •  Locate C:\path\to\atlassian-bamboo-agent2\conf\wrapper.conf and change the name of below 2 parameters as below and save the file.
		# Name of the service
		wrapper.name=bamboo-remote-agent-2

		# Display name of the service
		wrapper.displayname=Bamboo Remote Agent 2


  • Locate C:\path\to\atlassian-bamboo-agent2\bin directory and execute the bat file InstallBambooAgent-NT.bat . This will create the second remote agent service named Bamboo Remote Agent 2 but the service will be in stopped state.
  • In the Windows Run terminal type services.msc to open the windows services console. Locate the Bamboo Remote Agent 2 and start the service.

Similarly you can create and install multiple remote agents on the windows machine by setting unique values for the parameters -Dbamboo.home, wrapper.name and wrapper.displayname.

For details on the Windows Agent install commands please refer to the Install section in this page.

Last modified on Feb 9, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.