Unable to rename remote agent from bamboo-agent.cfg.xml

Summary

Users are unable to effectively rename remote agent from <BAMBOO_AGENT_HOME>/bamboo-agent.cfg.xml.

Steps to Reproduce

1. Install remote agent (e.g. following our documentation).
2. Make sure the remote agent connects to Bamboo at least one time. When the remote agent first connects to Bamboo, it sends the hostname as its name, which is then registered and stored in Bamboo's database.
3. Stop the remote agent.
4. Open up the <BAMBOO_AGENT_HOME>/bamboo-agent.cfg.xml file.
5. Change the <name> tag to rename the remote agent.
6. Start the remote agent.

Expected Results

Bamboo should display the updated remote agent's name in the UI after restarting the agent.

Actual Results

Bamboo continues to display the old agent's name even though the agent logs show the new/updated name.

Workaround

Right now, to rename the agent and ensure consistency go through the following steps every time you need to rename a remote agent:

1. Open up the remote agent <BAMBOO_AGENT_HOME>/bamboo-agent.cfg.xml file and change the <name> tag to rename the remote agent.
2. From the UI go to the Bamboo administration > Agents page.
   • Locate the remote agent from step 1 under the tabs "Online" or "Offline".
   • Click the agent name. You'll get redirected to the remote agent summary page.
   • Click Edit details.
   • Use the "Name" field to rename the remote agent.

Basically you'll have to rename the agent in two different places. You'll have to go through steps 1 & 2 to rename the remote agent and ensure that both the bamboo-agent.cfg.xml file and the database are in sync.