How to rename Bamboo Agent home directory
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. 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
If you are wondering how to safely rename a Remote Agent's home directory after it has successfully been in service, this is the right place. This is to ensure that the Remote Agent will look for your configuration files in the correct place. If you simply rename the Remote Agent's home directory and start the Agent, it will create a brand new directory and will install the Remote Agent from scratch. It will not use your existing data.
Solution
1. Stop Remote Agent
It is very important to stop the Remote Agent before making any changes. If you intend to rename the Remote Agent's home directory, please make sure it is not running before proceeding.
2. Update Remote Agent configuration files
The following files should be manually updated after renaming the Remote Agent's home directory:
<bamboo-agent-home>/bamboo-agent.cfg.xmlThere's a parameter named <buildWorkingDirectory> inside this file that will look like this:
1<buildWorkingDirectory>/Users/bamboo/Documents/Atlassian/remote-agents/bamboo-5.10.3/home/xml-data/build-dir</buildWorkingDirectory>Update the path to reflect the directory name change.
<bamboo-agent-home>/conf/wrapper.confThere's a java parameter named -Dbamboo.home inside this file:
1wrapper.java.additional.1=-Dbamboo.home=/Users/bamboo/Documents/Atlassian/remote-agents/bamboo-5.10.3/homeUpdate it to reflect the directory name change.
Was this helpful?