Bamboo 2.6 upgrade guide
On this page:
Supported Platforms
Please read the Supported platforms page for the full list of supported platforms for Bamboo.
Upgrading from Bamboo 2.5 to 2.6
We strongly recommended that you back up your xml-data directory before proceeding. For full instructions please follow the Bamboo upgrade guide.
We also strongly recommend that you export your Bamboo data for backup before proceeding. Please note, that this may take a long time to complete depending on the number of builds and tests in your system. For full instructions please see Exporting data for backup.
If you are using plugins, please make sure that your plugins are compiled against 2.6 before upgrading.
Before you upgrade, please read the following important points that relate to Bamboo 2.6.
Please set aside some time when upgrading to Bamboo 2.6 or later
As part of the performance improvements in version 2.6, test result data is stored differently. In versions of Bamboo prior to (and excluding) 2.6, all test result data has been stored in XML files on the filesystem. From Bamboo 2.6, some* of this test result data is stored in the database, permitting quicker retrieval of this information (and consequently faster Bamboo responsiveness) than what can be achieved by accessing XML files.
* Only test result data from failed and fixed builds is stored in the database, since this data will most likely be examined by Bamboo users. (Fixed builds are those which built successfully but had failed the previous time they were built.) Be aware that the test result data for successful builds is still stored in XML files on the filesystem.
During the Bamboo 2.6 upgrade process, relevant test result data generated by previous versions of Bamboo will automatically be migrated to the database when Bamboo 2.6 first starts up. No user-intervention is required during this process, which only runs once.
All subsequent Bamboo starts will not involve this data migration process.
Bamboo administrators should be aware that this data migration process might take some time, depending on the amount of data that needs to be moved to the database. In many cases, this process should be completed within a matter of minutes. However, if your stored test result data is extensive, this data migration process could take over an hour.
The table below is a guideline to help provide an estimate on how long it will take this data migration process to complete during the Bamboo upgrade procedure. The first column is a multiplication of the number of builds in history with the average number of test results per build. You can estimate the number of builds in history by multiplying the number of plans configured in Bamboo by the number of times each of these plans has run. For example, if you have 20 plans configured and each plan has run 300 times, there will be 6,000 builds (i.e. 20 x 300) in the build history. Note that expired builds are removed from the build history.
Number of Builds in History x Number of Tests per Plan | Estimated Migration Time |
|---|---|
2,500,000 (5,000 x 500) | < 3 min |
5,000,000 (10,000 x 500) | < 6 min |
10,000,000 (20,000 x 500) | < 10 min |
15,000,000 (30,000 x 500) | < 15 min |
20,000,000 (40,000 x 500) | < 25 min |
25,000,000 (50,000 x 500) | < 45 min |
30,000,000 (60,000 x 500) | < 75 min |
35,000,000 (70,000 x 500) | up to 3 hours |
The estimated migration time (above) is only just an estimate. The actual time it will take for this step of your Bamboo 2.6 upgrade to complete will also strongly depend on the performance of the hardware running Bamboo and the database that Bamboo uses.
Automatic Clover Integration Issue
A bug in Bamboo 2.6 forces automatic Clover integration and adds Clover targets or goals for Ant, Maven and Grail builds, despite having opted for manual Clover integration.
If you are affected by this issue, please apply the patch provided in JIRA issue BAM-5920.
Bamboo Home Directory — Disk Usage changes
This issue only affects Bamboo 2.6 and is fixed in Bamboo 2.6.1 and above.
Due to backend changes in Bamboo 2.6 (implemented for a feature that will be fully supported in a future version of Bamboo), the structure for storing temporary build files in the Working Directory has changed.
In versions of Bamboo prior to (and excluding) 2.6 had the following structure:
.../xml-data/build-dir/PLAN-KEY/
From Bamboo 2.6, the location for storing this data is now:
.../xml-data/build-dir/AGENTID/PLAN-KEY/
Hence, each agent now has its own directory for storing temporary build files, which means that the disk usage requirements for the Bamboo Home directory have increased in Bamboo 2.6. If you are concerned about disk usage, please upgrade to Bamboo 2.6.1 or above.
Changes in seraph-config.xml that affect new Bamboo security features
As part of the brute force attack protection feature (introduced in Bamboo 2.5.5) and Captcha on public signup, the following lines have been added to the seraph-config.xml file.
<rolemapper class="com.atlassian.bamboo.user.authentication.BambooRoleMapper"/>
<authenticator class="com.atlassian.bamboo.user.authentication.BambooAuthenticator"/>
<controller class="com.atlassian.bamboo.user.authentication.BambooSecurityController"/>
<elevatedsecurityguard class="com.atlassian.bamboo.user.authentication.BambooElevatedSecurityGuard"/>
If you use a customized version of the seraph-config.xml file with Bamboo, you will need to ensure that these lines of code are added to your customized seraph-config.xml, to ensure the availability of these new Bamboo security features.
Other 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 these other known issues in the Bamboo Knowledge Base. Before you begin the upgrade, please check for any of these other known issues in the Bamboo Knowledge Base first and if provided, follow the instructions to apply any necessary patches.
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.
Developing for Bamboo 2.6
If you are a Bamboo plugin developer, please refer to our Changes for Bamboo 2.6 guide, which outlines changes in Bamboo 2.6 that may affect Bamboo plugins compiled for Bamboo version 2.5.x or earlier.
Upgrading from Bamboo prior to 2.5
In addition to the above, please read the upgrade guide for every version you are skipping during the upgrade.
In particular, if you are upgrading from a version of Bamboo prior to 2.0, please ensure that you upgrade to Bamboo 2.0.6 first before upgrading to Bamboo 2.5.
Please ensure that you read the Bamboo 2.0 upgrade guide which contains important upgrade instructions for upgrading from earlier versions of Bamboo.