Migrate the Bamboo configuration from MySQL 5.7 to 8.0

Summary

This article explains how to update your Bamboo configuration to migrate from MySQL 5.7 to MySQL 8.0, including AWS RDS instances. This article will not cover the database's dataset migration; please check with your Database administrator or provider for details.

The instructions below are valid for on-premises and hosted MySQL databases.

Environment

• Bamboo

• MySQL 5.7

• MySQL 8.0

Requisites

MySQL 8.0 support was introduced in Bamboo 8.1.1. If you are running a version of Bamboo earlier than 8.1.1, please upgrade your instance first.

Solution

When upgrading your database version from MySQL 5.7 to 8.0, Bamboo's MySQL driver needs to be updated to support the new Database version:

1. Make sure you are running Bamboo 8.1.1 or later. If not, please upgrade it first

2. Stop your Bamboo instance

3. Run the MySQL dataset migration from 5.7 to 8.0 in parallel – We are not covering these steps here

4. In Bamboo, locate the MySQL 5.1 driver in the <bamboo-install>/lib folder. The file name should look like mysql-connector-java-5.1.XX-bin.jar

5. Move the driver file to a location outside of your Bamboo installation. Make it available in case you need to roll back its version.

6. Download the MySQL Connector/J 8 driver from https://dev.mysql.com/downloads/connector/j/5.1.html (select the Platform independent version), extract the jar file and copy it to the <bamboo-install>/lib folder. 

   1. To download the MySQL Connector/J 8.0.X series, you need to click on the Archives tab or just head to this page directly: https://downloads.mysql.com/archives/c-j/

   2. Supported MySQL Connector versions can be found on the Bamboo Supported Platforms page

7. Adjust the permissions and ownership of the new driver file so they align with the Bamboo service account

8. Edit your <bamboo-home>/bamboo.cfg.xml configuration file and update the Hibernate driver class used by Bamboo from com.mysql.jdbc.Driver to com.mysql.cj.jdbc.Driver

   1 <property name="hibernate.connection.driver_class">com.mysql.cj.jdbc.Driver</property>

9. In the same <bamboo-home>/bamboo.cfg.xml file, review any connection settings in the hibernate.connection.url property and adjust it to reflect the new Database URL and options (This is a MySQL connection example, adjust to your own requirements):

   1 <property name="hibernate.connection.url">jdbc:mysql://mysql.mydomain.net/bamboo?useSSL=true&autoReconnect=true&useUnicode=true&characterEncoding=utf8&connectionCollation=utf8mb4_bin</property>

10. Start Bamboo