Bamboo 5.3 Upgrade Guide

Bamboo 5.3 Release Notes

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

The instructions on this page describe how to upgrade to Bamboo 5.3 from a previous version of Bamboo. For details on the Bamboo 5.3 release, see the Bamboo 5.3 Release Notes.

Please follow the Bamboo 5.x specific instructions on this page, in addition to the upgrade instructions in the Bamboo upgrade guide.

Please read the Supported platforms page for the full list of supported platforms for Bamboo.

On this page:

Upgrade path

The rough upgrade path for Bamboo is: "older versions > 2.0.6 > 2.6.3 > 2.7.4 > 5.3 (the latest version).

Note that there is no requirement to downgrade before upgrading.

Upgrade notes from Bamboo 5.2 to 5.3

Bamboo 5.3 includes features that protect you against XSRF attacks.

These features are potentially disruptive, but we encourage you to enable them early so that you can test compatibility of your scripts and plugins.

See Configuring XSRF protection to learn how to manage your XSRF attack protection.

For security reasons, Atlassian recommends enabling XSRF protection after upgrade. Disable it only if you find out that it prevents your workflows from working. If that happens, you will be able to disable XSRF protection without any consequences.

Is my Bamboo server already protected against XSRF attacks?

Customers upgrading...XSRF protection enabled
an existing installation of Bamboo 5.2 and below to Bamboo 5.3 and above(error) Customers will need to enable XSRF protection using the instructions on this page
a new installation of Bamboo 5.3 and above(tick) XSRF protection enabled
Bamboo OnDemand (Bamboo 5.3 and above)(tick) XSRF protection enabled

Upgrade notes from Bamboo 5.x to 5.3

Tomcat now replaces Jetty as the standalone app server since Bamboo version 5.1.0. This means that the way Bamboo is started, stopped and upgraded has changed. Also, the custom configurations done in the  <Bamboo installation directory>/conf/wrapper.conf should be transferred to  <Bamboo installation directory>/bin/setenv.sh file (or <Bamboo installation directory>/bin/setenv.bat for Windows instances) as there is no wrapper.conf file in Bamboo server since version 5.1.0 (the wrapper still exists for the remote agents). For more information about how to configure some of the parameters that were set using the wrapper, please refer to - Configuring your system properties.

Please follow the below listed steps when upgrading to Bamboo from version 5.x to 5.3 (in addition to migrating the custom changes from the wrapper to setenv.sh).

Linux

  1. Export and back up your existing Bamboo data, as described in Step 1 of the Bamboo upgrade guide
  2. Delete your old BAMBOO_INSTALL directory to remove any legacy files
  3. Install Bamboo 5.3 as described in Step 2 of the Bamboo upgrade guide
  4. Point the new installation to the old 'Bamboo Home' by changing the path at file <Bamboo installation directory>/atlassian-bamboo/WEB-INF/classes/bamboo-init.properties
  5. Configure your new Bamboo 5.3 instance as described in Step 3 of the Bamboo upgrade guide
  6. Start Bamboo, re-indexing as required.

Mac

  1. Export and back up your existing Bamboo data, as described in Step 1 of the Bamboo upgrade guide
  2. Install Bamboo 5.3 using the Mac installer. The Mac installer will remove the previous version of Bamboo.
  3. Configure your new Bamboo 5.3 instance as described in Step 3 of the Bamboo upgrade guide
  4. Start Bamboo, re-indexing as required.

Windows

  1. Export and back up your existing Bamboo data, as described in Step 1 of the Bamboo upgrade guide
  2. If you have Bamboo running as a windows service, you should uninstall this service, using the UninstallService.bat executable that came with your existing Bamboo instance
  3. Install Bamboo 5.3 using the Windows .EXE installer. The Windows installer will remove the previous version of Bamboo.
  4. Configure Windows to run as a service, using the service.bat executable
  5. Configure your new Bamboo 5.3 instance as described in Step 3 of the Bamboo upgrade guide
  6. Start Bamboo, re-indexing as required.

Starting and stopping Bamboo

Linux and Mac

Starting and Stopping Bamboo on Windows and Mac has changed.

From within the Bamboo 5.3 installation directory:

Starting
./bin/start-bamboo.sh
Stopping
./bin/stop-bamboo.sh

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

Upgrade notes from Bamboo from 4.1.x and later to 5.3

To upgrade to Bamboo 5.3 follow the instructions in the Bamboo upgrade guide.

We strongly recommend that you back up your Bamboo instance and database before upgrading, as described in the Bamboo upgrade guide.

'buildnumber.txt' generation has been removed and replaced by an optional plugin

The 'buildnumber.txt' file is no no longer automatically generated in the working directory. If you rely on this functionality, then you must install the the Build Number Stamper plugin from the Atlassian Marketplace.

No agent upgrade required

In Bamboo 3.2, agents were changed so that no upgrade of agents are required. When Bamboo is upgraded, agents will automatically restart and update their executables from the server.

Upgrading from Bamboo prior to 4.1

In addition to the notes below, please read the Upgrade Guide for every version you are skipping during the upgrade. 

Notes for upgrading from Bamboo 4.0

  • Bamboo's deprecated Remote API has been removed. If you are using this API, migrate to the Bamboo REST API.
  • There are no major schema upgrade tasks that may cause the Bamboo upgrade from 3.4 to 4.0 to take an extended amount of time.
  • If you are using Elastic Bamboo, we've upgraded JDK6, Grails 1.2, Grails 1.3 and Maven 3 to the latest minor releases on the stock images. Additionally, we've added Grails 2.0 to the image. See here for a complete list of elastic image contents.

Notes for upgrading from Bamboo 3.2

Notes for upgrading from a version of Bamboo prior to 2.7.4

  • You will need to upgrade to Bamboo 2.7.4 before upgrading to Bamboo 4.3. If you are using a version of Bamboo earlier than 2.6.3, we recommend that you upgrade to 2.6.3 before upgrading to Bamboo 2.7.4. Bamboo 2.6.3 can be downloaded from the Bamboo Archived Downloads page. Bamboo 2.7.x introduces a number of significant and irreversible changes, so a phased upgrade is recommended. Please see the Bamboo 2.7.x Upgrade Guide for more details.
  • You will need to set aside time, as described in the Bamboo 2.7.x Upgrade Guide, for Bamboo to migrate existing Plans to the new Plan structure in Bamboo 2.7.4.
  • If you are upgrading from Bamboo 2.5 or earlier, you will need to set aside time, as described in the Bamboo 2.6 Upgrade Guide for Bamboo to migrate its test result data (stored in XML files on the filesystem) into the database.
  • If you are upgrading from a version of Bamboo prior to 2.0, you must upgrade to Bamboo 2.0.6 first before upgrading to Bamboo 2.6.3 ( and then 2.7.4). Please read the Bamboo 2.0 Upgrade Guide for important upgrade instructions for upgrading from earlier versions of Bamboo.

Developing for Bamboo 5.3

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

Checking for known issues and troubleshooting the Bamboo upgrade

If something is not working correctly after you have completed the steps above to upgrade your Bamboo installation, please check for known Bamboo issues and try troubleshooting your upgrade as described below:

  • Check for known issues. Sometimes we find out about a problem with the latest version of Bamboo after we have released the software. In such cases we publish information about the known issues in the Bamboo Knowledge Base. Please check the Bamboo Known Issues in the Bamboo Knowledge Base and follow the instructions to apply any necessary patches if necessary.
  • Did you encounter a problem during the Bamboo upgrade? Please refer to the guide to troubleshooting upgrades in the Bamboo Knowledge Base.
  • If you encounter a problem during the upgrade and cannot solve it, please create a support ticket and one of our support engineers will help you.
Last modified on May 26, 2016

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.