This guide describes upgrade tasks that are common to upgrades for all Bamboo versions. Please ensure that you also read the upgrade guide for the version you are upgrading to.

Step 1. Export and back up Bamboo data

Export the Bamboo database

In Bamboo, export your Bamboo database, for backup purposes. See Exporting data for backup for instructions. Note that this may take a long time to complete depending on the number of builds and tests in your system.

If you are using an external database, then use the native database backup tools to acquire a database dump.

On this page:

Related pages:

Back up the Bamboo configuration

Shut down Bamboo.

Back up your 'Bamboo Home' directory, which includes the builds and configuration directories.

Click Administration, and then System Information (under 'System') in your Bamboo instance, and note the location of the 'Bamboo Home', 'Build Path' and 'Configuration Path' directories (under 'Bamboo Paths'):

For more information about these directories see Important Directories and Files.

Step 2. Install the new Bamboo version

  • Make sure that your {BAMBOO_INSTALL} directory is either a new directory, or else delete your old {BAMBOO_INSTALL} directory before you begin, as legacy files may cause problems.
  • The {BAMBOO_HOME} directory must be different from the {BAMBOO_INSTALL} directory. This will ensure that your data is not lost when upgrading or re-installing Bamboo.

 

If you are installing using the Windows installer or the Mac installer:

  • Ensure that you then point the new installation to the old 'Bamboo Home', changing the path at file <Bamboo-install>/webapp/WEB-INF/classes/bamboo-init.properties.

Follow Steps 1 and 2 of the installation instructions for your operating system:

Step 3. Configure the new Bamboo

Reconnect external user directories

You only need to perform this step if either of the following apply:

  • LDAP integration — If you had previously integrated Bamboo with LDAP/AD, copy your old ../<Bamboo-install>/webapp/WEB-INF/classes/atlassian-user.xml to it's new location. Starting with version 3.2, the atlassian-user.xml file will be stored at {BAMBOO-HOME}/xml-data/configuration/. Please replace the existing file using your old atlassian-user.xml. 
  • Crowd integration — If you had previously integrated Bamboo with Crowd, you will need to re-enable Crowd integration. For details please see Integrating Crowd with Bamboo.

Update any installed plugins

If you are using any plugins other than the ones that ship with Bamboo, check that each one is compatible with the new version of Bamboo. Upgrade any plugins that are out-of-date, and disable any plugins that are incompatible with your new version of Bamboo.

Automatic upgrade of remote agents

For Bamboo 3.2 and later, remote agents are upgraded automatically. The remote agent can automatically detect when a new version is available, and has a special classloader that downloads the new classes from the server.

See also the Bamboo remote agent installation guide.

Configure Context path

If you had a context path configured for your Bamboo instance (http://hostname:[port]/context_path), please follow the steps from here: Changing Bamboo's root context path.

Step 4. Launch Bamboo

Start Bamboo

Before starting Bamboo, ensure that Bamboo has write access to your database. This is required to complete the upgrade tasks that will run when you start up Bamboo. Please consult your database documentation to ensure that you have configured your database appropriately.

Once you have installed Bamboo and set the bamboo.home property (as described in the installation guides), start Bamboo. The upgrade process will be performed when Bamboo starts up. You will not see the Setup Wizard.

Monitor the atlassian-bamboo.log to ensure that the upgrade process completes successfully.

Reindex Bamboo (if indicated in the release notes)

Bamboo maintains an index of its build results. This allows Bamboo to display aggregate build results information across builds. You may need to perform a re-index of Bamboo if the upgrade process requires it. This step may or may not be required (depending on the upgrade versions). Also note that you only need to do this if you have existing data in Bamboo.

To re-index, go to Administration, then Indexing (under 'System'). 

Depending on the number of builds and tests you may have, the indexing process may take a significant amount of time. During this period, Bamboo will not be available. Also, it is advisable to ensure that all you have disabled all build queues (or all agents, if you are upgrading from Bamboo 2.0 or later), and that no builds are in progress when you start the re-indexing process. If you have a large instance, it is recommended that you reindex overnight.

WAR distribution is no longer distributed

Since Tomcat is now shipped in the standalone and Tomcat being the only application server we officially support, the EAR/WAR edition of Bamboo is no longer distributed via www.atlassian.com.

If you wish to get the war file, you can do so by downloading it at this url (replacing $VERSION with the version you wish to download):

https://maven.atlassian.com/content/repositories/atlassian-public/com/atlassian/bamboo/atlassian-bamboo-web-app/$VERSION/atlassian-bamboo-web-app-$VERSION.war

Troubleshooting

If you have any problems during upgrade, please raise a support request at https://support.atlassian.com/ and attach your atlassian-bamboo.log so we can help you find out what's gone wrong.