Bamboo upgrade guide

You can upgrade Bamboo by installing a new version of Bamboo and setting it up with the configuration of the original Bamboo instance.

On this page

Overview

The recommended paths for upgrading Bamboo to a new version differ depending on whether you want to move to a new server or not:

In both scenarios, the new Bamboo instance uses the home directory and the database of the original Bamboo instance.

If you are a Bamboo plugin developer, see our Bamboo API Changes by Version guide, which outlines changes in Bamboo that may affect Bamboo plugins compiled for earlier versions of Bamboo.

Recommended upgrade path

Before you begin

• Read the specific upgrade notes for your version of Bamboo.
• Read End of support announcements for Bamboo.
• Check whether the system where you are going to install the new Bamboo instance meets the requirements.
• Check whether any add-ons may require an update. 

1. Export and back up the existing Bamboo data

Export the Bamboo database

There are two database backup scenarios, depending on whether you are using an embedded or external database.

Stop Bamboo

Stop the original Bamboo instance.

If you have Bamboo running as a Windows service, uninstall the service by using the UninstallService.bat executable that came with your Bamboo instance.

Back up the Bamboo configuration

When the original Bamboo instance is shut down, back up your <bamboo-home> directory, which contains the builds and configuration directories. You can compress it into a .zip file.

2. Download and install a new Bamboo instance

To upgrade Bamboo, you must install a new Bamboo instance in a  <bamboo-install> directory that is different from the <bamboo-install> directory of the original Bamboo instance .

 This upgrade scenario uses the home directory and the external database of the original Bamboo instance.

The guidelines for the new Bamboo instance installation are the following:

Mac OS X

• The Mac installer deletes the previous version of Bamboo.
• Follow the Mac OS X install instructions.

Linux

• Delete your old <Bamboo-install> directory to remove any legacy files.
• Follow the Linux install instructions.

Windows

• The Windows installer deletes the previous version of Bamboo.
• Follow the Windows install instructions.
• Configure Bamboo to run as a service on Windows, using the service.bat executable.

3. Configure the new Bamboo instance

Set the home directory for the new Bamboo instance

 Set the <home-directory> to use the <home-directory> of the original Bamboo instance:

1. Go to the new Bamboo instance <bamboo-install> directory. It is the directory where you installed Bamboo.

2. Open atlassian-bamboo/WEB-INF/classes/bamboo-init.properties 

   For Bamboo versions prior to 5.1, the file path is: <bamboo-install>/webapp/WEB-INF/classes/bamboo-init.properties

3. Set the bamboo.home variable to use the <bamboo-home> path of the original Bamboo instance.

Reconnect external user directories (optional)

If you had integrated the original Bamboo instance with Crowd or LDAP, you must enable the integration for the new Bamboo instance.

For more information, see Integrating Crowd with Bamboo and Integrating Bamboo with LDAP.

Update any installed add-ons

If you installed any add-ons in addition to the pre-installed system add-ons:

• Check if all add-ons are compatible with the new version of Bamboo.
• Update any add-ons that are out-of-date.
• Disable any add-ons that are incompatible with the new version of Bamboo.

Automatic update of remote agents

For Bamboo 3.2 and later, remote agents are updated automatically. Remote agents automatically detect when a new version is available and downloads new classes from the server.

For more information, see Bamboo remote agent installation guide.

Configure the context path

If you had a context path configured for the original Bamboo instance (http://hostname:[port]/context_path), you have to configure it for the new Bamboo instance. For more information, see Changing Bamboo's root context path.

Check database access permission

Before you start the new Bamboo instance, make sure that it has the write access to the database, which is required to complete the upgrade tasks.

4. Start Bamboo

Start Bamboo

Once you have installed Bamboo and set the bamboo.home property, start the new Bamboo instance. The upgrade runs automatically.

You can check whether the upgrade was successful in the atlassian-bamboo.log file.

Version-specific upgrade notes

The version-specific notes provide additional information to the main upgrade documentation. We recommend reading the version-specific notes for the original and new Bamboo instance versions.

Upgrading to Bamboo 5.13

See also:

• the general update steps section above.
• Bamboo 5.13 Release Notes.
• the Bamboo Supported platforms page.

You might also want to check our developer documentation.

Upgrading to Bamboo 5.12

See:

• the general update steps section above.
• Bamboo 5.12 Release Notes.
• the Bamboo Supported platforms page.

You might also want to check our developer documentation.

Upgrading to Bamboo 5.11

See:

• the general update steps section above.
• Bamboo 5.11 Release Notes.
• the Bamboo Supported platforms page.

You might also want to check our developer documentation.

Upgrading to Bamboo 5.10

See:

• the general update steps section above.
• Bamboo 5.10 Release Notes.
• the Bamboo Supported platforms page.

You might also want to check our developer documentation.

Upgrading to Bamboo 5.9

See also:

• the general update steps section above.
• the Bamboo 5.9 Release Notes.
• the Bamboo Supported platforms page.

Changes to Clover Plugin integration

Automatic Clover integration for Maven 2 and Maven 3 tasks has been changed. It has tighter integration and adds Clover goals between goals from an original command so that a build will be performed only once (i.e. it will not run a separate build phase as it did before). Automatic Clover integration will not happen when your Maven task contains the install or deploy commands; this is to protect your repositories from being polluted by instrumented code. Therefore, please check if any of your Maven tasks that use automatic Clover integration use the install or deploy Maven commands. If they do: either disable automatic Clover integration for those jobs, or change the phase to the verify command (or earlier) or set up a dedicated job for Clover. Otherwise, your jobs will not produce Clover's coverage reports.

Upgrading to Bamboo 5.8

See also:

• the general update steps section above.
• the Bamboo 5.8 Release Notes.
• the Bamboo Supported platforms page.

If you are upgrading from Bamboo versions earlier than Bamboo 4.0, you must upgrade to any of Bamboo 5.0–5.7 before upgrading to Bamboo 5.8.

Hibernate dialect update

When you upgrade to Bamboo 5.8, an upgrade task will run that changes the Hibernate dialect in the bamboo.cfg.xml file. The new dialects are:

org.hibernate.dialect.PostgreSQLDialect
org.hibernate.dialect.HSQLDialect
org.hibernate.dialect.Oracle10gDialect
org.hibernate.dialect.MySQL5Dialect
com.atlassian.bamboo.hibernate.SQLServerIntlDialect

Upgrading to Bamboo 5.7

See also:

• the general update steps section above.
• the Bamboo 5.7 Release Notes.
• the Bamboo Supported platforms page.

Global deployment expiry

Upgrading to Bamboo 5.6

See also:

• the general update steps section above.
• the Bamboo 5.6 Release Notes.
• the Bamboo Supported platforms page.

Bitbucket Server notifications and the Bitbucket Server web repository type are deprecated

Bitbucket Server notifications and the legacy Bitbucket Server web repository type are deprecated in Bamboo 5.6, and will be removed in Bamboo 5.7. Use the Bitbucket Server repository integration available in Bamboo 5.6, which is based on application links, to replace that functionality. Read about using Bitbucket Server repositories with Bamboo on Bitbucket Server.

Update time

When scheduling the outage window for the Bamboo 5.6 update, keep in mind that update task 4407 that is executed during the update may take up to 45 minutes to complete on large instances, depending on the size of the VARIABLE_CONTEXT table. For a more precise calculation, assume that 10 minutes are needed to process 15 million records in that table.

Installer package on MAC OS X can not be opened due to code signing requirements 
Note, this issue was found in Bamboo 5.4 and still applies to Bamboo 5.6.

Previously, Mac OS X required binaries to be Developer ID signed in order to run out of the box. Without signing, users would receive a warning that the app isn't from the App Store or a registered Apple Developer. Users were able to apply a work-around to solve this problem.

The latest version of Mac OS X (10.8 and above), however, now reports that the Bamboo installer for Mac is corrupted rather than being blocked by developer ID.

Please see  BAM-11742 - Getting issue details... STATUS  for more information.

1. The Mac installer will not be available until this has been resolved
2. There is a temporary work-around available here.

This is a small bug with our installer. Please be assured that we are working on a permanent solution to this issue.

Upgrading to Bamboo 5.5

• We recommend that you add OAuth authentication (in addition to existing authentication) to any existing application links between your Bamboo and Bitbucket servers. If you have previously integrated Bamboo with Bitbucket Server, you will probably have Basic HTTP authentication configured for your link. The new Bitbucket repository type will work with Basic HTTP, but OAuth is a better as it is an impersonating authentication type. For more information, see Configuring authentication for an application link.
• Git will use --ancestry-path when trying to extract changeset due to  BAM-13760 - Getting issue details... STATUS . Since that command is available for Git 1.7.2 and above (see Release Notes), please update your native Git, if you have Git 1.7.1 installed (especially those who use RHEL 6 or CentOS).

See also:

• the general update steps section above.
• the Bamboo 5.5 release notes.
• the Bamboo  Supported platforms page.

Installer package on MAC OS X can not be opened due to code signing requirements

Note, this issue was found in Bamboo 5.4 and still applies to Bamboo 5.5.

Previously, Mac OS X required binaries to be Developer ID signed to run out of the box. Without signing, users would receive a warning that the app isn't from the App Store or a registered Apple Developer. Users were able to apply a work-around to solve this problem.

The latest version of Mac OS X (10.8 and above), however, now reports that the Bamboo installer for Mac is corrupted rather than being blocked by developer ID.

Please see  BAM-11742 - Getting issue details... STATUS  for more information.

1. The Mac installer will not be available until this has been resolved
2. There is a temporary work-around available here.

This is a small bug with our installer, please rest assured that we are working on a permanent solution to this issue.

Upgrading to Bamboo 5.4

Note that Bamboo will run a full reindex after updating.

See also:

• the general update steps section above.
• the Bamboo 5.5 release notes.
• the Bamboo Supported platforms page.

Installer package on MAC OS X can not be opened due to code signing requirements

Previously, Mac OS X required binaries to be Developer ID signed to run out of the box. Without signing, users would receive a warning that the app isn't from the App Store or a registered Apple Developer. Users were able to apply a work-around to solve this problem.

The latest version of Mac OS X (10.8 and above), however, now report that the Bamboo installer for Mac is corrupted rather than being blocked by developer ID.

Please see  BAM-11742 - Installer package is "damaged and cannot be reopened" on Mac OS X RESOLVED  for more information.

1. The Mac installer will not be available until this has been resolved
2. There is a temporary work-around solution available here.

This is a small bug with our installer, please rest assured that we are working on a permanent solution to this issue.

Troubleshooting

If you followed the documentation and you still have problems with the upgrade process:

• Check the ARCHIVED - How to Upgrade/Migrate Bamboo article in the Bamboo Knowledge Base.
• Check other Knowledge Base articles.
• Ask questions at https://answers.atlassian.com.
• You can also create a support ticket. To help us address the issue, attach the atlassian-bamboo.log file to the ticket.