Documentation for Bamboo 4.0.x. Documentation for earlier versions of Bamboo is available too.

Before you begin

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.

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

Step 1. Identify your Bamboo directories

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

On this page:

Related pages:

 

Step 2. Shut down Bamboo

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

Step 3. Back up Bamboo

Backing up Bamboo consists of two tasks:

  1. Back up your 'Bamboo Home', 'Build Path' and 'Configuration Path' directories, as 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'.
  2. Export your Bamboo data for backup. See Exporting data for backup for instructions. Please note, that this may take a long time to complete depending on the number of builds and tests in your system.

Step 4. Re-install Bamboo

(info) Please note the following:
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' directory 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

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>/webapps/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.

Step 7. Start Bamboo

Before you start Bamboo

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 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.

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.

4 Comments

  1. user-56566

    Jan 19, 2010

    In step 4, it states that the MySQL driver needs to be installed. Doesn't it come bundled with the latest releases of Bamboo?

  2. David Corley

    Jul 21, 2010

    In step 3 you refer to a "Build Data Path" that is not listed in Step 1. It's pretty obvious it should refer to "Build Path", but thought I'd note it here for correction.

  3. Anonymous

    Nov 13, 2010

    I'm using Tomcat 6 and Mysql 5, and while upgrading from 2.6 to 2.7.1 I was getting the following errors in my Tomcat startup logs:

    2010-11-13 13:15:35,088 ERROR \[main\] \[AbstractUpgradeManager\] java.sql.SQLException: Can't call commit when autocommit=true
java.sql.SQLException: Can't call commit when autocommit=true
&nbsp;&nbsp; &nbsp; &nbsp; &nbsp;at com.mysql.jdbc.SQLError.createSQLException(SQLError.java:933)
&nbsp;&nbsp; &nbsp; &nbsp; &nbsp;at com.mysql.jdbc.SQLError.createSQLException(SQLError.java:930)
&nbsp;&nbsp; &nbsp; &nbsp; &nbsp;at com.mysql.jdbc.ConnectionImpl.commit(ConnectionImpl.java:1643)
&nbsp;&nbsp; &nbsp; &nbsp; &nbsp;at org.apache.tomcat.dbcp.dbcp.DelegatingConnection.commit(DelegatingConnection.java:301)

    I had to add the following to my JDBC Connection pool definition in order to get Bamboo to start and continue the upgrade process:

    &amp;relaxAutoCommit=true

    Once I added the above configuration parameter it started working again.

  4. Barry Nijkamp

    Nov 13, 2011

    In step 3, substep 2, the manual states that during the upgrade an export of Bamboo is required. The manual links to the page that explains how to backup the data from the running application, however in step 1 we already shut down Bamboo. Please correct the manual so the steps are in the correct order.



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Blog and update our documentation.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.