Use Jira to connect to OceanBase Database

Jira is a project management and issue tracking tool developed by Atlassian. It supports agile development, task management, and team collaboration. This topic describes how to integrate Jira with OceanBase Database. You can use OceanBase Database as the backend database of Jira to seamlessly replace MySQL. After you configure the connection to OceanBase Database and resolve the version compatibility issues, Jira can run stably on OceanBase Database.

Version compatibility

• OceanBase Database version: ≥ V4.4.1
• Jira version: ≤ 9.1

Limitations

• The official Docker image of Jira 8.4 and later versions no longer includes the MySQL driver. You need to manually download and mount the driver package.
• OceanBase needs to be configured with MySQL version 5.7.2 to be compatible with the default database type check in Jira 8.20.10.

Prerequisites

Before you use Jira to connect to OceanBase Database, make sure that:

• You have deployed OceanBase Database and created a MySQL mode user tenant. For more information, see Create a tenant.
• You have installed the Docker environment.

Procedure

Step 1: Obtain the connection string of OceanBase Database

Contact the OceanBase Database deployment personnel to obtain the connection string, for example:

obclient -h$host -P$port -u$user_name -p$password -D$database_name

Parameter description:

• $host: the connection IP address. For ODP connections, use the ODP address. For direct connections, use the OBServer IP address.

• $port: the connection port. For ODP connections, the default port is 2883. For direct connections, the default port is 2881.

• $database_name: the database name.

  Notice

  The user who connects to the tenant must have the CREATE, INSERT, DROP, and SELECT privileges on the database. For more information about user privileges, see Privilege types in MySQL mode.

• $user_name: the connection account. For ODP connections, the format is user@tenant#cluster or cluster:tenant:user. For direct connections, the format is user@tenant.

• $password: the account password.

For more information about the connection string, see Connect to an OceanBase tenant by using OBClient.

Example:

obclient -hxxx.xxx.xxx.xxx -P2881 -utest_user001@mysql001 -p****** -Dtest

Step 2: Deploy Jira

1. Download the MySQL connector driver package:

   wget https://repo1.maven.org/maven2/com/mysql/mysql-connector-j/8.0.33/mysql-connector-j-8.0.33.jar
   

2. Start Jira by using Docker:

   docker run -d \
     --name="jira" \
    -p 8082:8080 \
    -v ./mysql-connector-j-8.0.33.jar:/opt/atlassian/jira/lib/mysql-connector-j-8.0.33.jar \
    atlassian/jira-software:8.20.10
   

   Parameter description:

   • --name="jira": specifies the container name as jira.
   • -p 8082:8080: maps port 8080 in the container to port 8082 on the host.
   • -v ./mysql-connector-j-8.0.33.jar:/opt/atlassian/jira/lib/mysql-connector-j-8.0.33.jar: mounts the downloaded MySQL driver to the specified path in the container.
   • atlassian/jira-software:8.20.10: specifies the Jira image version.

Step 3: Configure OceanBase Database

1. Access the Jira configuration interface: go to http://$host:8082 in your browser, where $host is the IP address or domain name of the Jira server.

2. On the database configuration page, select MySQL as the database type.

3. Enter the OceanBase Database connection information:

   • Host Name: the IP address or domain name of OceanBase Database.
   • Port: the port of OceanBase Database (default value: 2881 or 2883).
   • Database Name: the name of the database to be used.
   • Username: the username for connecting to the database.
   • Password: the password for connecting to the database.

4. Click Next to continue the configuration.

Step 4: Activate the Jira license

1. After the Jira configuration is completed, go to the license activation page.
2. Purchase the Jira license and enter the license key.
3. Click Activate to complete the activation process.

Verification

After the preceding configuration is completed, Jira is connected to OceanBase Database. You can perform the following verification steps:

1. Log in to the Jira management console and check the system status.
2. Create test projects and issues in Jira to confirm that data can be stored and read normally.
3. Check OceanBase Database to confirm that the tables related to Jira are created successfully.

FAQ

Q1: Driver for the database MySQL not found

Cause: Starting from Atlassian Jira 8.4, due to licensing reasons, the official Docker image no longer includes the MySQL driver JAR package by default. You need to manually place the driver package into the lib directory of the container.

Solution: Download the MySQL driver JAR package as described in Step 2 and mount it into the container using a Docker Volume.

Q2: MySQL 5.6 database is not compatible with MySQL 5.7 database type. Consider changing it to MySQL 5.6.

Cause: OceanBase Database defaults to MySQL 5.6 compatibility, while Jira 8.20.10 defaults to MySQL 5.7.

Solution: Execute the following command in OceanBase Database to modify the MySQL version:

alter proxyconfig set mysql_version='5.7.2';

Q3: Execution of set session default_storage_engine = "InnoDB"; failed

Cause: Earlier versions of OceanBase Database had restrictions on setting the default_storage_engine variable.

Solution: This issue has been fixed in OceanBase Database V4.4.1. If you are using an earlier version, upgrade to V4.4.1 or later.