Jira を MySQL 8.0 に接続する

このページの内容

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

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

はじめる前に

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

  • 既知の問題を確認します。
  • If you are migrating Jira to another server, create an export of your data as an XML backup. You will then be able to transfer data from your old database to your new database, as described in Switching databases.
  • If you plan to set up Confluence and Jira on the same MySQL server, read the Confluence MySQL setup guide. Confluence requirements are more strict than Jira's, so you should configure MySQL to suit Confluence. This configuration will work for Jira, too.
  • セットアップ ウィザードを実行中の場合を除き、開始する前に Jira をシャットダウンします。

 

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

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


  1. Create a database user which Jira will connect as, for example jiradbuser

    CREATE USER '<USERNAME>' IDENTIFIED BY '<PASSWORD>';
  2. Create a database for Jira to store issues in, for example jiradb.

    The database must have a character set of UTF8. To set it, enter the following command from within the MySQL command client:

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

    GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,ALTER,INDEX on <JIRADB>.* TO '<USERNAME>'@'<JIRA_SERVER_HOSTNAME>';
    flush privileges;
  4. Edit the my.cnf or my.ini (Windows) file in your MySQL Server (for detailed instructions on editing these files, see MySQL Option Files).

  5. ファイルで [mysqld]  セクションを見つけ、次のパラメータを追加あるいは修正します。

    • デフォルトのストレージエンジンを InnoDB に設定します:

      [mysqld]
      ...
      default-storage-engine=INNODB
      ...
    • データベース サーバーが使用する文字セットを指定します。

      [mysqld]
      ...
      character_set_server=utf8mb4
      ...
    • 初期設定の行形式を DYNAMIC に設定します。

      [mysqld]
      ...
      innodb_default_row_format=DYNAMIC
      ...
    • 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
  6. 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 インストール ディレクトリにコピーします。

  1. 推奨される MySQL ドライバ、JDBC Connector/J 8.0 をダウンロードします。 

  2. ドライバを次のディレクトリにコピーします。

    <Jira-installation-directory>/lib

    If you are installing Jira using the Windows installer, you will need to do this step after running the Windows installer, but  before  running the setup wizard.

  3. Jira サービスを再起動します。

  4. If you are installing Jira, skip the rest of the instructions on this page and access Jira in your browser to run the setup wizard instead.

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

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

セットアップ ウィザード

Use the setup wizard if you have just installed Jira, and are setting it up for the first time. Your settings will be saved to the dbconfig.xml file in your Jira home directory.

手順を表示する...

The Jira setup wizard will display when you access Jira for the first time in your browser.

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

設定ツール

Use the configuration tool if you have an existing Jira instance. Your settings will be saved to the dbconfig.xml file in your Jira home directory.

手順を表示する...
  1. Run the Jira configuration tool.
  2. [Database] タブに進み、[Database Type] を MySQL 8.0 に設定します。
  3. 下記の「データベース コネクション フィールド」セクションを参照して各フィールドを入力します。
  4. 接続をテストし、保存します。
  5. Jira を再起動します。

4. Jira の起動

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

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

The table below explains database connection fields that you can find in the setup wizard, Jira configuration tool, or the dbconfig.xml file.

データベース コネクション フィールド...
セットアップウィザード/設定ツール説明 dbconfig.xml
ホスト名MySQL サーバがインストールされている、マシンの名前あるいは IP アドレス。

<url> タグにあります。以下の例では dbserver です。

<url>jdbc:mysql:/dbserver:3306/jiradb?useUnicode=true&amp;characterEncoding=UTF8&amp;sessionVariables=default_storage_engine=InnoDB</url>


IPv6 アドレスを使用している場合は、URL を以下のようにする必要があります。

<url>jdbc:mysql://address=(protocol=tcp)(host=dbserver)(port=3306)/jiradb?useUnicode=true&amp;characterEncoding=UTF8&amp;sessionVariables=default_storage_engine=InnoDB</url>
ポートMySQL サーバがリッスンしている TCP/IP ポート。デフォルトのポートを利用する際は、ここを空白にします。

<url> タグにあります。以下の例では 3306 です。

<url>jdbc:mysql://dbserver:3306/jiradb?useUnicode=true&amp;characterEncoding=UTF8&amp;sessionVariables=default_storage_engine=InnoDB</url>
データベースThe name of your MySQL database (into which Jira will save its data). You should have created this in Step 1 above.

<url> タグにあります。以下の例では jiradb です。

<url>jdbc:mysql://dbserver:3306/jiradb ?useUnicode=true&amp;characterEncoding=UTF8&amp;sessionVariables=default_storage_engine=InnoDB</url>
ユーザ名MySQL サーバーに接続する際に Jira が利用するユーザーです。上記のステップ 1 で作成したものです。
<username>jiradbuser</username>
パスワードMySQL サーバとの認証に利用する、ユーザのパスワードです。
<password>jiradbuser</password>
dbconfig.xml のサンプル ファイル...
  • For more information about the child elements of <jdbc-datasource/> beginning with pool in the dbconfig.xml file above, see Tuning database connections.
  • Both the 

    マクロ「include」のレンダリング中にエラーが発生しました

    com.atlassian.renderer.v2.macro.MacroException: No page title provided.

     setup wizard and database configuration tool also add the element <validation-query>select 1</validation-query> to this file, which is usually required when running Jira with default MySQL installations. See Surviving connection closures for more information.
  • 以下の例のデータベース 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>mysql8</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.cj.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 8.0 を使用するように Jira が構成されている場合も次の警告を表示します。

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

ソリューション

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

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

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

問題が解消されない場合は、MySQL サーバーで使用されている照合が utf8mb4_bin に設定されていることを確認します。

サーバーのタイムゾーン値 "CET" が認識されない

Jira を MySQL 8.0 と実行すると、タイムゾーンに関連する次の問題が発生することがあります。

これが発生した場合は、2 つの方法で解決できます。

オプション 1:

  1. MySQL サーバーの my.cnf または my.ini (Windows) ファイルを編集します (これらのファイルの編集の詳細な手順については「MySQL オプション ファイル」を参照してください)。

  2. ファイルで [mysqld] セクションを見つけ、次のパラメータを追加あるいは修正します。

    default_time_zone='+00:00' 
  3. MySQL サーバーを再起動します。

オプション 2:

  1. Jira ホーム ディレクトリで dbconfig.xml ファイルを編集します。
  2. 以下の例のように、serverTimezone=UTC<url> に追加します。
<url>jdbc:mysql://address=(protocol=tcp)(host=0.0.0.0)(port=3306)/jiradb?sessionVariables=default_storage_engine=InnoDB&amp;serverTimezone=UTC</url>
権限のホスト名が文字列として比較される...

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 で課題を作成する際に問題が生じる可能性があります。

最終更新日: 2021 年 10 月 6 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.