This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Before you begin

Please read the Release Notes and Upgrade Guides for the version you are upgrading to.



Step 1. Backing up

You need to back up three directories. Your Bamboo Home, Build Data Path and Configuration Path directories. If you do not remember what these are, you can simply go to the System Info page in the Administration menu of your Bamboo instance to check.




Step 2. Upgrading Bamboo

Windows Self Extracting installer:

Launching the installer Bamboo_windows_version.exe will install Bamboo. The install wizard requires the input of two directories:

  1. Installation directory (BAMBOO_INSTALL) - the directory where the application files will be installed to.

    Make sure that you either specify a new directory to install to or delete the old Bamboo installation directory as legacy files may cause problems.






  1. Bamboo Home directory (BAMBOO_HOME) - this is the directory where Bamboo will store all data for this installation. Please point this to the Bamboo Home directory as was seen in the Administration System Info screen in step 1.

Generic .tgz or .zip archive:

  1. Unpack the archived standalone version to the directory of your choice. All unpacked files reside in a Bamboo directory. Note: To unpack the .tgz distributable, run the command tar vxf filename (for .tgz distributable).

    Make sure that you either unzip into a new directory or delete the old Bamboo directory as legacy files may cause problems.






  1. Check your Bamboo Home directory - this is the directory where Bamboo will store all data for this installation. Make sure that the file named bamboo-init.properties in the Bamboo\webapp\WEB-INF\classes directory contains the bamboo.home line with with the absolute path to your Bamboo Home (BAMBOO_HOME) directory. If it does not exist, you will need to add it.
    bamboo.home=BAMBOO_HOME
    




    When specifying the Bamboo home directory, please ensure that you enter the absolute path. On Windows systems, backslashes needs to be escaped. For example instead of C:\dev\bamboo-home use

    bamboo.home=C:\\dev\\bamboo-home
    










    You may want to specify the Bamboo home directory separate from the installation directory. This will ensure that your data is not lost when upgrading or re-installing Bamboo.






    Alternatively you may specify an environment variable 'bamboo.home' which specifies the absolute path to your Bamboo Home directory. Bamboo will check if an environment variable is defined.






Step 3. Start Bamboo

Once you have installed Bamboo and set the bamboo.home property, you can start Bamboo. The upgrade tasks will fire in the startup sequence of Bamboo. As a safeguard, you can monitor the atlassian-bamboo.log to ensure that the upgrade process has completed successfully.

Step 4. Re-Index Bamboo (as indicated in release notes)

Bamboo maintains an index of its 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). To re-index, simply go to "Administration", then "Indexing", and hit the Reindex button. You only need to do this if you have existing data in Bamboo.

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 build queues are disabled and no builds are progressing when you start the re-indexing process. If you have a large instance, we suggest 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.

  • No labels