Jira アプリケーションの管理のサポート

We plan to end the support for MySQL 5.7 in Jira 9.2. For more information, follow our release notes, end of support announcements, and supported platforms updates.

ここでは、サポート対象の MySQL データベースに Jira を接続する方法を解説します。

はじめる前に
MySQL データベースの作成および設定
MySQL JDBC ドライバのコピー
Jira を構成してデータベースに接続
Jira の起動
データベース接続フィールド
既知の問題

はじめる前に

前提条件として次の情報を確認しておくことをおすすめします。

既知の問題を確認します。
Jira を別のサーバーに移行する場合は、バックアップとしてデータのエクスポートを作成してください。その後、「データベースの切り替え」で説明されているように、元のデータベースから新しいデータベースにデータを移行できるようになります。
Confluence と Jira を同じ MySQL サーバーでセットアップする場合は、「Confluence MySQL セットアップガイド」をお読みください。Confluence の要件は Jira の要件よりも厳格であるため、MySQL は Confluence に適するように構成します。この構成は Jira にも適用できます。
セットアップウィザードを実行中の場合を除き、開始する前に Jira をシャットダウンします。

1. MySQL データベースの作成および設定

あとから Jira をデータベースに接続する際に必要になるため、データベースを作成するときに、データベース名、ユーザー名、およびポート番号を記録しておきます。

Jira が接続時に使用するデータベースユーザーを作成し、名前をつけます (例: jiradbuser)。
課題を格納するための Jira 用データベースを作成します (例: jiradb)。

このデータベースでは UTF8 の文字セットが設定されている必要があります。設定するには、MySQL コマンドクライアントから以下のコマンドを入力します。
```
CREATE DATABASE jiradb CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
```

データベースへの接続権限とテーブルの作成および更新権限がユーザーに割り当てられていることを確認します。これらの権限は次のコマンドで付与できます。

MySQL 5.7.0 - 5.7.5:

GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,ALTER,INDEX on <JIRADB>.* TO '<USERNAME>'@'<JIRA_SERVER_HOSTNAME>' IDENTIFIED BY '<PASSWORD>';
flush privileges;

MySQL 5.7.6 以降 (REFERENCES 権限も含める必要があります):

GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,ALTER,INDEX on <JIRADB>.* TO '<USERNAME>'@'<JIRA_SERVER_HOSTNAME>' IDENTIFIED BY '<PASSWORD>';
flush privileges;

MySQL Server の my.cnf または my.ini (Windows) ファイルを編集します (ファイルの編集の詳細な手順については MySQL オプションファイルを参照してください)。
ファイルで [mysqld] セクションを見つけ、次のパラメータを追加あるいは修正します。
- デフォルトのストレージエンジンを InnoDB に設定します:
```
[mysqld]
...
default-storage-engine=INNODB
...
```
- データベースサーバーが使用する文字セットを指定します。
```
[mysqld]
...
character_set_server=utf8mb4
...
```
- 初期設定の行形式を DYNAMIC に設定します。
```
[mysqld]
...
innodb_default_row_format=DYNAMIC
...
```
- large プレフィックスを有効にします。
```
[mysqld]
...
innodb_large_prefix=ON
...
```
- InnoDB ファイル形式を Barracuda に設定します。
```
[mysqld]
...
innodb_file_format=Barracuda
...
```
- innodb_log_file_size の値が 2 GB 以上になるように指定します。
```
[mysqld]
...
innodb_log_file_size=2G
...
```
- sql_mode パラメーターが NO_AUTO_VALUE_ON_ZERO に指定されていないことを確認します。
```
// remove this if it exists
sql_mode = NO_AUTO_VALUE_ON_ZERO
```
MySQL サーバーを再起動して変更内容を反映します。

Windows...

Windows サービスマネージャーを利用してサービスを再起動します。
Linux...
お使いのセットアップに応じて、以下のいずれかのコマンドを実行します:
/etc/init.d/mysqld stop
/etc/init.d/mysql stop
service mysqld stop
次に "stop" を "start" に置き替えて同じコマンドを実行します。

2. MySQL JDBC ドライバのコピー

MySQL の JDBC ドライバを Jira インストールディレクトリにコピーします。

次のいずれかの推奨 MySQL ドライバーをダウンロードします。
- MySQL Connector/J 8.0 ドライバー
- MySQL Connector/J 5.1 ドライバー
ドライバを次のディレクトリにコピーします。
```
<Jira-installation-directory>/lib
```
Windows インストーラーを利用して Jira をインストールしている場合、このステップを、Windows インストーラーの実行後、セットアップウィザードの実行前に行う必要があります。
Jira サービスを再起動します。
Jira をインストールする場合、このページの残りの説明をスキップし、ブラウザで Jira にアクセスしてセットアップウィザードを実行します。

3. Jira を構成してデータベースに接続する

ご使用の MySQL データベースに接続するために Jira サーバーを設定する方法は 2 つあります。

セットアップウィザード

Jira をインストールした直後で、初めて Jira をセットアップする場合はセットアップウィザードを使用します。設定は、Jira ホームディレクトリの dbconfig.xml ファイルに保存されます。

セットアップウィザードで MySQL に接続する

ブラウザから初めて Jira にアクセスすると、Jira セットアップウィザードが表示されます。

最初の画面の [Configure Language and Database] で、[Database Connection] に [ My own database] を設定します。
[Database Type] を MySQL 5.7+ に設定します。
下記の「データベースコネクションフィールド」セクションを参照して各フィールドを入力します。
接続をテストし、保存します。

設定ツール

既存の Jira インスタンスがある場合は、設定ツールを使用します。設定は、Jira ホームディレクトリの dbconfig.xml ファイルに保存されます。

設定ツールで MySQL に接続する

Jira 設定ツールを次のように実行します。
- Windows: コマンドプロンプトを開いて、Jira インストールディレクトリの bin サブディレクトリにある config.bat を実行します。
- Linux/Unix: コンソールを開いて、Jira インストールディレクトリの bin サブディレクトリにある config.sh を実行します。
  
  このコマンドは「No X11 DISPLAY 変数が原因で Jira アプリケーション設定ツールを起動できなかったのは、設定エラーによるもの」に記載のエラーで失敗する場合があります。その場合は、この記事の回避策をご参照ください。
[Database] タブに進み、[Database Type] を MySQL 57+ に設定します。
下記の「データベースコネクションフィールド」セクションを参照して各フィールドを入力します。
接続をテストし、保存します。
Jira を再起動します。

4. Jira の起動

これで、MySQL データベースに接続するための Jira の設定が完了しました。次のステップでは、これを起動させます。

データベース接続フィールド

以下の表では、セットアップウィザード、Jira 設定ツール、または dbconfig.xml ファイルにあるデータベースコネクションフィールドについて説明します。

データベース接続フィールドを表示する

セットアップウィザード/設定ツール	説明	dbconfig.xml
ホスト名	MySQL サーバがインストールされている、マシンの名前あるいは IP アドレス。	`<url>` タグにあります。以下の例では dbserver です。 `<url>jdbc:mysql:/dbserver:3306/jiradb?useUnicode=true&characterEncoding=UTF8&sessionVariables=default_storage_engine=InnoDB</url>` IPv6 アドレスを使用している場合は、URL を以下のようにする必要があります。 `<url>jdbc:mysql://address=(protocol=tcp)(host=dbserver)(port=3306)/jiradb?useUnicode=true&characterEncoding=UTF8&sessionVariables=default_storage_engine=InnoDB</url>`
ポート	MySQL サーバがリッスンしている TCP/IP ポート。デフォルトのポートを利用する際は、ここを空白にします。	`<url>` タグにあります。以下の例では 3306 です。 `<url>jdbc:mysql://dbserver:3306/jiradb?useUnicode=true&characterEncoding=UTF8&sessionVariables=default_storage_engine=InnoDB</url>`
データベース	お使いの MySQL データベースの名前 (Jira データの保存先)。上記ステップ 1 で作成したものです。	`<url>` タグにあります。以下の例では jiradb です。 `<url>jdbc:mysql://dbserver:3306/jiradb ?useUnicode=true&characterEncoding=UTF8&sessionVariables=default_storage_engine=InnoDB</url>`
ユーザ名	MySQL サーバーに接続する際に Jira が利用するユーザーです。上記のステップ 1 で作成したものです。	`<username>jiradbuser</username>`
パスワード	MySQL サーバとの認証に利用する、ユーザのパスワードです。	`<password>jiradbuser</password>`

dbconfig.xml のサンプルファイルを表示する

上記の dbconfig.xml ファイルに含まれる、pool で始まる <jdbc-datasource/> の子要素の詳細については、「データベース接続のチューニング」を参照してください。
Jira セットアップウィザードとデータベース設定ツールも、<validation-query>select 1</validation-query> 要素をこのファイルに追加します。これは通常、既定の MySQL インストールを使用して Jira を実行する際に必要です。詳細は、「コネクション切断の問題を乗り越える方法」を参照してください。
以下の例のデータベース URL は、UTF-8 データベースを想定しています。つまり、データベースが create database jiradb character set utf8; などのコマンドを使用して作成されています。このデータベースの作成時に character set utf8 を指定しない場合、データのインポート時に "Data truncation: Data too long for column" エラーが発生したり、サポート対象外の文字の文字化けが発生したりする可能性があります。
以下の例のデータベース URL には、sessionVariables=default_storage_engine=InnoDB パラメーターが含まれます。データ破損を防ぐために、このパラメーターを追加することを強くお勧めします。

<jira-database-config>
  <name>defaultDS</name>
  <delegator-name>default</delegator-name>
  <database-type>mysql57</database-type>
  <jdbc-datasource>
    <url>jdbc:mysql://dbserver:3306/jiradb?useUnicode=true&amp;characterEncoding=UTF8&amp;sessionVariables=default_storage_engine=InnoDB</url>
    <driver-class>com.mysql.jdbc.Driver</driver-class>
    <username>jiradbuser</username>
    <password>password</password>
    <pool-min-size>20</pool-min-size>
    <pool-max-size>20</pool-max-size>
    <pool-max-wait>30000</pool-max-wait>
    <pool-max-idle>20</pool-max-idle>
    <pool-remove-abandoned>true</pool-remove-abandoned>
    <pool-remove-abandoned-timeout>300</pool-remove-abandoned-timeout>
 
    <validation-query>select 1</validation-query>
    <min-evictable-idle-time-millis>60000</min-evictable-idle-time-millis>
    <time-between-eviction-runs-millis>300000</time-between-eviction-runs-millis>
  
    <pool-test-while-idle>true</pool-test-while-idle>
    <pool-test-on-borrow>false</pool-test-on-borrow>
    <validation-query-timeout>3</validation-query-timeout>
  </jdbc-datasource>
</jira-database-config>

既知の問題

以下は、このデータベースに関する既知の問題の一覧です。詳細については、それぞれを展開してください。

ヘルスチェックで照合がサポートされていないという警告が表示される

データベースのヘルスチェックは、MySQL 5.7 を使用するように Jira が構成されている場合も次の警告を表示します。

Your mysql database is currently using an unsupported collation: utf8mb4_bin. You should change this to a supported collation: utf8_bin

ソリューション

この問題は dbconfig.xml ファイルが適切なデータベースタイプで更新されず、mysql57 ではなく mysql を使用している場合に生じる可能性があります。ファイルを手動で編集することで、この問題を修正できます。

Jira ホームディレクトリに移動し、dbconfig.xml ファイルを編集します。
database-type を mysql57 に変更します。

これは上述のように、Jira 構成ツールを使用して変更することもできます。

権限に含まれるホスト名が文字列として比較される

localhost などのホスト名に MySQL の権限を付与する場合、Jira からデータベースに接続するときと同じ文字列を使用する必要があります。同じ場所に解決される場合であっても、127.0.0.1を使用することはできません。これを行わない場合、Jira がセットアップされたときに JDBC 接続に新しいテーブルを作成する権限がないため、テーブルが見つからない旨の警告が表示されます。

接続に問題が発生した可能性がある

以下のいずれかを利用して MySQL データベースを使用している場合、コネクションが切断される問題が発生する可能性があります (詳しくは JRA-15731 を参照してください)。

JIRA 3.13 以降、
Tomcat 5 のバージョン 5.5.25 以上
Tomcat 6 のバージョン 6.0.13 以上

これに対処する方法の詳細については、「コネクション切断の問題を乗り越える方法」を参照してください。

データベースパスワードで特殊文字がサポートされていない

Jira が特殊文字を解釈できないため、データベースパスワードでは特殊文字はサポートされていません。

バイナリロギング

Jira は、MySQL の "READ-COMMITTED" トランザクション分離レベルを使用しており、これは現在は行ベースのバイナリログのみに対応しています。

MySQL のバイナリログ機能が必要な場合、MySQL のバイナリログの形式を '行ベース' に設定する必要があります。これを行わない場合、Jira で課題を作成する際に問題が生じる可能性があります。

Jira アプリケーションの管理のサポート

製品

Jira Software

Jira Service Management

Jira Work Management

Confluence

Bitbucket

リソース

関連ドキュメント

コミュニティ

提案とバグ

Marketplace

請求とライセンス情報

Jira アプリケーションを MySQL 5.7 に接続する

Jira アプリケーションのデータベースへの接続

このページの内容

お困りですか?

はじめる前に

1. MySQL データベースの作成および設定

2. MySQL JDBC ドライバのコピー

3. Jira を構成してデータベースに接続する

セットアップウィザード

設定ツール

4. Jira の起動

データベース接続フィールド

既知の問題

ページ

Viewport

Confluence

バージョン

Jira アプリケーションを MySQL 5.7 に接続する

Jira アプリケーションのデータベースへの接続

このページの内容

関連コンテンツ

お困りですか?

はじめる前に

1. MySQL データベースの作成および設定

2. MySQL JDBC ドライバのコピー

3. Jira を構成してデータベースに接続する

セットアップ ウィザード

設定ツール

4. Jira の起動

データベース接続フィールド

既知の問題

関連コンテンツ

セットアップウィザード