All Versions

   Bamboo 5.0.x
   Bamboo 4.4.x
   Bamboo 4.3.x
   Bamboo 4.2.x  
   More... 

Bamboo 3.0 Documentation

Index
Downloads (PDF, HTML & XML formats)

This documentation relates to an earlier version of Bamboo.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata

Before you begin

Icon

This upgrade guide contains generic upgrade tasks that are common across Bamboo versions. Please ensure that you also read the Upgrade Guide for the version you are upgrading to.

Icon

Bamboo 3.0 has been released. Read the Bamboo 3.0 Release Notes and Upgrade Guide.
Don't have Bamboo 3.0? Take a look at the features of Bamboo's latest major version and try it out!

Step 1. Identify your Bamboo directories

Go to the 'System Info' page in the 'Administration' menu of your Bamboo instance and note the location of the Bamboo Home, Build Data Path and Configuration Path directories:

Step 2. Shut down Bamboo

You need to shut down Bamboo before backing up or performing the upgrade.

Step 3. Back up Bamboo

Back up your Bamboo Home, Build Data Path and Configuration Path directories, identified in Step 1. For more information about these directories please see Important Directories and Files.

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

Note that it is not necessary to back up your Working Directory.

Step 4. Re-install Bamboo

(info) Please note:
If you are installing using the .zip or .tgz packages:

  • When specifying the {BAMBOO_HOME} directory, use the same Bamboo Home directory as in your old installation. That is, specify the same directory and path as the Bamboo Home directory shown in 'Step 1' (above).

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

  • Ensure that you will create a new empty database that can be used during the installation Wizard and that the Bamboo Home directory from the old installation will not be used. The new installation will need to point to a new path so that a new Bamboo Home can be created. Once the installation was finished, you can then point the new installation to the old Bamboo Home, changing the path at file <Bamboo-install>/webapps/WEB-INF/classes/bamboo-init.properties
  • 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.

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

Step 5. Update 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.

Step 6. Re-configure external user repositories (if applicable)

  • LDAP integration — If you had previously integrated Bamboo with LDAP/AD, copy your old ../<Bamboo-install>/webapps/WEB-INF/classes/atlassian-user.xml file to the new Bamboo installation.
  • 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.

Step 7. Start Bamboo

Before you start Bamboo

Icon

Bamboo needs to have write access to your database 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 has completed successfully.

Step 8. Re-index Bamboo (if indicated in release notes)

Bamboo maintains an index of its build results. This allow 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', and click the 'Reindex' button. 

Icon

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.

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.