Upgrading Bamboo 5.0 - 5.13 to latest on Windows
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
This article provides an outline of the upgrade process for Bamboo Server 5.0+ to a recent version. For generic upgrade documentation, see Bamboo upgrade guide
Solution
Environment used in this document
Current Version | Target version |
|---|---|
Bamboo Server 5.9.7 | Bamboo Server 6.8.0 |
For this example, we'll be upgrading to Bamboo 6.8.0. At the time of writing this document, the same procedure can be applied to all recent versions of Bamboo.
Prerequisites
Double check if your environment meets the supported platforms requirements for Bamboo 6.8.0:
Checklist:
Java | JDK 1.8 |
|---|---|
Database | MySQL 5.6.3 - 5.7 PostgreSQL 9.4 - 10 SQL Server 2012 - 2016 Oracle 12c |
CVS | Git 1.8.1.5 and later Mercurial 1.8 and later Subversion 1.5 - 1.8 |
Pre-upgrade tasks
Make sure Bamboo is not running
Backup of the current environment
Make sure the JAVA_HOME variable is pointing to valid JDK 1.8 installation
Checklist:
Backups | Create backups for the following data: Bamboo Database
Bamboo installation directory |
|---|---|
JAVA_HOME | Run the below commands in terminal: echo %JAVA_HOME% The output should be something similar to this: C:\Users\Administrator>echo %JAVA_HOME% C:\Program Files\Java\jdk1.8.0_131 java -version The output should be something similar to this: C:\Users\Administrator>java -version java version "1.8.0_131" Java(TM) SE Runtime Environment (build 1.8.0_131-b11) Java HotSpot(TM) 64-Bit Server VM (build 25.131-b11, mixed mode) |
Run the upgrade
Before starting the upgrade, please make sure to complete the previous steps (Prerequisites and Pre-upgrade tasks)
For this example, Bamboo is installed at the following paths:
bamboo-home → E:\Atlassian\bamboo-home
<<Installation folder>> → E:\Atlassian\install
Step 1 - Stop Bamboo service
Bamboo running as a Windows Service
Run the following command on CMD/PowerShell
PS C:\> net stop BambooExpected output:
PS C:\> net stop Bamboo
The Bamboo service is stopping..
The Bamboo service was stopped successfully.
PS C:\>Or open Control Panel > Administrative Tools > Services, find Bamboo service, right click on it and select "Stop Service"
Bamboo running in console:
Run the E:\Atlassian\install\bin\stop-bamboo.bat script:
PS E:\Atlassian\install\bin> .\stop-bamboo.bat
Expected output:
PS E:\Atlassian\install\bin> .\stop-bamboo.bat
Bamboo Server Edition
Version : 5.9.7
JAVA_HOME "C:\Program Files\Java\jdk1.8.0_131" contains spaces. Please change to a location without spaces if this cause
s problems.
If you encounter issues starting or stopping Bamboo Server, please see the Troubleshooting guide at https://confluence.a
tlassian.com/display/BAMBOO/Installing+Bamboo+on+Windows
Using CATALINA_BASE: "E:\Atlassian\install"
Using CATALINA_HOME: "E:\Atlassian\install"
Using CATALINA_TMPDIR: "E:\Atlassian\install\temp"
Using JRE_HOME: "C:\Program Files\Java\jdk1.8.0_131"
Using CLASSPATH: "E:\Atlassian\install\bin\bootstrap.jar;E:\Atlassian\install\bin\tomcat-juli.jar"
Java HotSpot(TM) 64-Bit Server VM warning: ignoring option MaxPermSize=256m; support was removed in 8.0
PS E:\Atlassian\install\bin>Step 2 - Download Bamboo 5.14
Go to Bamboo Download Archives and download the following binary:
5.14.4.1 - Windows Installer, 64-bit binary
After the download finishes, you should see something similar to this:
Step 3 - Run Bamboo 5.14 setup Wizard
⚠️ Make sure you have a backup from the bamboo-home folder and the database before proceeding.
Double click at the atlassian-bamboo-5.14.4.1-windows-x64 executable to start the setup wizard
At the first screen, select: "Yes, Update the existing installation" and hit "Next"
Now, select the location of the bamboo-home folder:
Wait until the installation finishes:
Step 4 - Check the configurations
While using Bamboo, you’ve probably added some custom modifications to Bamboo files. These may include connection details, settings related to memory allocation, or other JVM arguments. In this step, you need to re-apply the same modifications to the new files by copying them from your backups.
Double check if all customisations made to the following files are correct:
E:\Atlassian\install\bin\setenv.bat
ℹ️ Common personalisations made to this file are:
Java arguments, i.e:
#
# Occasionally Atlassian Support may recommend that you set some specific JVM arguments. You can use this variable below to do that.
#
JVM_SUPPORT_RECOMMENDED_ARGS:="-Dbamboo.ec2.agent.endpoint=http://localhost:8085-XX:UseG1GC"
#
Heap memory size, i.e:
#
# The following 2 settings control the minimum and maximum given to the Bamboo Java virtual machine. In larger Bamboo instances, the maximum amount will need to be increased.
#
JVM_MINIMUM_MEMORY="2048m"
JVM_MAXIMUM_MEMORY="2048m"
#E:\Atlassian\install\bin\server.xml
This file contains the configuration for the ports where Bamboo service will be listening including ssl, reverse proxy configuration and so on.
Step 5 - Start Bamboo 5.14
Start Bamboo 5.14 by executing the E:\Atlassian\install\BambooConsole.bat file
Wait a little bit for the upgrade process finish, access Bamboo UI and check if everything is working as expected. If Bamboo did not start, please review the prerequisites and make sure you followed all the steps correctly.
If the problem persists, you can also create a support ticket. To help us address the issue, attach the the content of the <<Installation folder>>/logs/ folder to the ticket.
Step 6 - Stop Bamboo 5.14
Let's Stop Bamboo 5.14 so we can proceed with the upgrade.
Run the E:\Atlassian\install\bin\stop-bamboo.bat script:
PS C:\> cd E:\Atlassian\install\bin\
PS E:\Atlassian\install\bin> .\stop-bamboo.bat
Bamboo Server Edition
Version : 5.14.4.1
JAVA_HOME "C:\Program Files\Java\jdk1.8.0_131" contains spaces. Please change to a location without spaces if this cause
s problems.
If you encounter issues starting or stopping Bamboo Server, please see the Troubleshooting guide at https://confluence.a
tlassian.com/display/BAMBOO/Installing+Bamboo+on+Windows
Using CATALINA_BASE: "E:\Atlassian\install"
Using CATALINA_HOME: "E:\Atlassian\install"
Using CATALINA_TMPDIR: "E:\Atlassian\install\temp"
Using JRE_HOME: "C:\Program Files\Java\jdk1.8.0_131"
Using CLASSPATH: "E:\Atlassian\install\bin\bootstrap.jar;E:\Atlassian\install\bin\tomcat-juli.jar"You can use the JPS command to make sure Bamboo's JVM is fully stopped.
Step 7 - Download Bamboo 6.8.0
Go to Bamboo Download Archives and download the following binary:
6.8.0 - Windows Installer, 64-bit
After the download finishes, you should see something similar to this:
Step 8 - Run Bamboo 6.8.0 Setup Wizard
⚠️ Make sure you have a backup from the bamboo-home folder and the database before proceeding.
Double click at the atlassian-bamboo-6.8.0-windows-x64 executable to start the setup wizard
At the first screen, select: "Yes, Update the existing installation" and hit "Next"
Now, select the location of the bamboo-home folder:
Wait until the installation finishes:
Step 9 - Check the configuration
Double check if all personalisations made to the following files are correct:
Bamboo service running on console
E:\Atlassian\install\bin\setenv.bat
Common personalisations made to this file are:
Java arguments, i.e:
#
# Occasionally Atlassian Support may recommend that you set some specific JVM arguments. You can use this variable below to do that.
#
JVM_SUPPORT_RECOMMENDED_ARGS:="-Dbamboo.ec2.agent.endpoint=http://localhost:8085-XX:UseG1GC"
#
Heap memory size, i.e:
#
# The following 2 settings control the minimum and maximum given to the Bamboo Java virtual machine. In larger Bamboo instances, the maximum amount will need to be increased.
#
JVM_MINIMUM_MEMORY="2048m"
JVM_MAXIMUM_MEMORY="2048m"
#E:\Atlassian\install\bin\server.xml
This file contains the configuration for the ports where Bamboo service will be listening including ssl, reverse proxy configuration and so on.
Bamboo service as a windows service
Identify the name of the service that Bamboo is installed as in Windows (Control Panel > Administrative Tools > Services):
Open a command prompt from Start > Run > type 'cmd' > Enter.
Change directory to the bin directory of your Bamboo installation directory.
Run:
tomcat8w //ES//%SERVICENAME%
ℹ️ In the above example, it would be tomcat8w //ES//Bamboo
Click on the Java tab to see the list of current start-up options:
⚠️ If Bamboo is running as a Windows Service, you'll need to delete Bamboo 5.9.7 Service running E:\Atlassian\install\UninstallService.bat before installing the service for the new version of Bamboo, but before doing that, please make sure to copy the java options and heap memory parameters from the old service so you can replicate the same information to the new service.
E:\Atlassian\install\bin\server.xml
This file contains the configuration for the ports where Bamboo service will be listening including ssl, reverse proxy configuration and so on.
Step 10 - Start Bamboo 6.8
Start Bamboo 6.8 by executing the E:\Atlassian\install\BambooConsole.bat file
Wait a little bit for the upgrade process finish, access Bamboo UI and check if everything is working as expected. If Bamboo did not start, please review the prerequisites and make sure you followed all the steps correctly.
If the problem persists, you can also create a support ticket. To help us address the issue, attach the the content of the <<Installation folder>>/logs/ folder to the ticket.
ℹ️ If you want to install Bamboo as a windows service, run the E:\Atlassian\install\InstallAsService.bat file and then open Control Panel > Administrative Tools > Services to start the service.
Post-upgrade tasks
After you finish the upgrade:
Make sure everything is working as expected;
Double check if your remote agents are back online;
Double check if the application links are working;
Remove the folders created during the upgrade process:
Recovery Plan:
If something wrong happened during the upgrade:
Stop the application (Step 1)
Restore the backups created during the pre-upgrade tasks (bamboo-home and database)
Install the previous version (running the setup wizard)
If you could't rollback the upgrade, please create a support ticket. To help us address the issue, attach the the content of the E:\Atlassian\install\logs\ folder to the ticket.
Was this helpful?