Things to look for when changing Bamboo URL
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
The below list shows what you should look for when planning to change the URL of a Bamboo server.
- Bamboo Base URL: You can follow the steps on how to modify Bamboo Base URL mentioned in this KB: How to manually change the Base URL of Bamboo without access to the UI
- Broker URI and Broker Client URI: review these settings in
<bamboo-home>/bamboo.cfg.xml
- Bamboo URL on the remote agent side: update the server URL in
<remote-agent-home>/conf/wrapper.conf
- Reverse proxy settings in server.xml: update the location in
<bamboo-install>/conf/server.xml
- Load Balancers: settings need to be checked for the new URL change. (Note: Atlassian does not support External Load Balancer configurations)
- Application links: Check all external Application Links that interface with Bamboo and review their settings after the new Bamboo URL is available. The revision should be executed on all applications, including Jira, Bitbucket, etc."
Scan Script tasks: If you have script tasks that communicate with the Bamboo server by REST API, you must update it. You can find out using the below SQL query, which will list all the jobs and deployment environment keys that use old URLs at task configurations: Below queries are testing in Postgres Database. Replace
<BAMBOO_URL>
with the current base URL.List All the Tasks using current Bamboo URLSELECT B.FULL_KEY AS BUILD_PLAN_KEY FROM BUILD_DEFINITION BD INNER JOIN BUILD B ON BD.BUILD_ID = B.BUILD_ID WHERE BD.XML_DEFINITION_DATA LIKE '%<BAMBOO_URL>%'; SELECT DP.NAME AS DEPLOYMENT_PROJECT, DE.NAME AS DEPLOYMENT_ENVIRONMENT FROM DEPLOYMENT_PROJECT DP INNER JOIN DEPLOYMENT_ENVIRONMENT DE ON DP.DEPLOYMENT_PROJECT_ID = DE.PACKAGE_DEFINITION_ID WHERE DE.XML_DEFINITION_DATA LIKE '%<BAMBOO_URL>%';
User Management: If you are using Jira or Crowd for user management, the URL of the Bamboo server needs to change by editing the setting for the Bamboo application in Jira/Crowd to match the new URL.
Lockout recovery process
Jira/Crowd/AD may lock the Bamboo users from logging in to Bamboo Application due to the URL change. Please check the Lockout recovery process to recover administrator access.
External Application Webhooks: Review applications using Bamboo URLs to trigger build or monitoring.
Recommendation
We don't recommend doing multiple migrations simultaneously, for example, Bamboo and Bitbucket, Bamboo and Jira, etc. First, update the Bamboo URL, adjust accordingly and then make the other applications.