別のサーバーへの JIRA アプリケーションの移行
This document describes how to migrate/upgrade to JIRA applications on different server hardware, or in a different server environment that entails one or more of the following:
- JIRA アプリケーションを実行するオペレーティングシステムが変わる
- インデックスや添付ファイルの保存場所が変わる
- JIRA アプリケーションのデータを格納するデータベースまたはデータベース システムが変わる
移行時に JIRA アプリケーションを新しいバージョンにアップグレードする場合は、JIRA アプリケーションのアップグレード を参照し、アップグレードの前に必要な事前作業に関する情報を確認してください。
Windows から Linux にオペレーティング システムを変更する場合、またはその逆の場合、ファイルパスの入力に「スラッシュ」が必要な時は、向きを逆(「/」を「\」に、または「\」を「/」)にする必要があります。
On this page:
1. 始める前に
- ライセンスの確認 – お客様の ライセンスサポート期間 が有効期間内であることを確認します。
- 既知の問題の確認 - 影響を与える新しいバージョンの問題点を検索するには、JIRA ナレッジベースを利用します。
- 互換性の確認:
- 使用中のオペレーティング システム、データベース、その他の利用可能なプラットフォームおよびハードウェアが JIRA アプリケーションの 要件 を満たしていることを確認します。
- ソースとターゲットの各インスタンスが移行前に同じタイムゾーンに設定されていることをご確認のうえ、日時の各フィールドに関する問題を避けます。
- If you have installed JIRA application add-ons (i.e. not included with JIRA applications), verify that they will be compatible. You can find a add-on's compatibility information from the the add-on's home page on the Atlassian Marketplace. You can also follow the procedure outlined here: Checking app compatibility with application updates to have the Universal Add-on Manager help you with this.
最初にテスト環境で移行を実行してみることを強く推奨します。テスト環境でのアップグレードが成功しない限り、本番環境の JIRA サーバー アプリケーションの移行を行わないでください。
ウィルス対策ツールやインターネット セキュリティー ツールの中には、移行を妨げ、移行プロセスを正常に終了できなくするものがあります。ご利用のウィルス対策ツールまたはインターネット セキュリティ ツールでこの種の問題が発生した場合、または、発生が見込まれる場合は、まず対象ツールを無効にしてから、JIRA アプリケーションの移行を実行してください。
2. バックアップ
2.1 ユーザーに JIRA のデータ更新を中断させる
アップグレード プロセスで、JIRA のデータベースを既存の JIRA インストールから (XML バックアップ経由で) エクスポートし、このバックアップを新しい JIRA インストールに復元します。XML バックアップ内のデータと、システムの最新データとの整合性を確保するため、JIRA へのアクセスを一時的に制限してユーザーがデータを更新できないようにする必要があります。詳細は、「バックアップ中の JIRA アプリケーションへのユーザー アクセスを防止する」ページを参照してください。
注意してください!整合性のない XML バックアップを使って復元することはできません!
2.2 データベースのバックアップ
既存の JIRA インストールの外部データベースに対する XML バックアップを実行します。大規模な JIRA インストール環境では、このプロセスの完了まで数時間を要する場合もあります。
「組み込みデータベース」は、JIRA が提供する評価専用の H2 データベースです。誤って H2 データベースを本番環境で使用してしまった場合は、このデータベースの XML バックアップを作成してから、以下の手順を実行します。
2.3 JIRA ホームディレクトリのバックアップ
- Jira をシャットダウンします。
- Locate the JIRA home directory. You can find information about the location of the directory by navigating to the
<jira-application-dir>/WEB-INF/classes/jira-application.properties
file in your JIRA application installation directory. Alternatively, you can open the JIRA configuration tool to see the directory that is set as your JIRA Home. - 設定ファイルに記録されているディレクトリに移動して、別のディレクトリにそのバックアップを作成します。
- バックアップの完了直後に元のフォルダーから <jira-home>/dbconfig.xml ファイルを削除します。
2.4 添付ファイルおよびインデックスのディレクトリのバックアップ (JIRA ホームディレクトリ外にある場合)
添付ファイルおよびインデックスのディレクトリがJIRA ホームディレクトリ外にある場合は、この2つのディレクトリのバックアップをそれぞれ作成する必要があります。ご使用の実装でこれらのディレクトリの場所を見つける方法については、次のページで説明しています。
- 添付ファイル ディレクトリ — ご使用の JIRA バージョンのドキュメントで、 「ファイル添付の設定」ページを参照してください。
- インデックスディレクトリ — ご使用の JIRA バージョンのドキュメントで、「インデックス作成の検索」ページを参照してください。
JIRA の添付ファイルのバックアップに関する詳細は、「データのバックアップ」もご覧ください。
2.5 JIRA インストール ディレクトリのバックアップ
「JIRA インストールディレクトリ」 は、JIRA がインストールされた時に、JIRA アプリケーション ファイルとライブラリが展開されたディレクトリです。
3. 新規 JIRA アプリケーション インストールのセットアップ
「ミッション クリティカルな」JIRA サーバー アプリケーションを運用している場合、本番環境のアップグレードを実行する前に、本ガイドの残りのステップをテスト環境(たとえば、切り離されたテスト用の JIRA アプリケーション データベースと JIRA アプリケーション ホームディレクトリのコピーを使用する環境など)で実行することを強く推奨します。
3.1 JIRA アプリケーションの新バージョンのインストール
最初に、JIRA アプリケーションの現行バージョンであれ、新しいバージョンであれ、新規インストールによって作業を開始する必要があります。移行と同時に JIRA を新しいバージョンにアップグレードする場合は、JIRA アプリケーションのアップグレード を参照して、アップグレードの前に完了しておく必要がある事前作業の情報を確認してください。
必要な JIRA アプリケーションのディストリビューションをダウンロードし、新しいディレクトリに解凍します。既存の JIRA インストールに上書きしてはいけません。既存のインストールが終了していることを確認した後、新しい JIRA インストールを新たなロケーションにインストールします。
3.2 新しい JIRA アプリケーションに既存の JIRA アプリケーション ホームディレクトリ(のコピー)を参照させる
ディストリビューションのセットアップ方法
- JIRA 設定ツールを開きます。
- JIRA ホーム タブをクリックします。
- JIRA ホーム ディレクトリ フィールドを更新します:
- JIRA 7.3 インストールが新しいサーバー上にある場合は、JIRA ホームディレクトリ フィールドを、コピーした JIRA ホームディレクトリのパスに更新します。
- JIRA 7.3 インストールが同一サーバー上にある場合、JIRA ホーム ディレクトリ フィールドを既存の JIRA ホームディレクトリのパスに更新します。
このディレクトリに関する詳細は、「JIRA ホームディレクトリ」を参照してください。
OS 環境変数 JIRA_HOME
を定義することで Jira ホーム ディレクトリの場所を設定することも可能です。この変数の値は、Jira インストール ディレクトリ にある jira-application.properties
ファイルの jira.home
プロパティの値よりも優先されます。詳細は、「Jira ホーム ディレクトリの設定 」を参照してください。
3.3 JIRA アプリケーションの新しいバージョンを、新しい空のデータベースに接続する
ステージ 2 にある、ご利用のデータベースに対応した「Jira の ... (データベース名) への接続」の説明に従ます。ただし、ステップ 4 以降については次の黄色の注意事項をご確認ください。
データベース(jiradb など)は、既存の JIRA インストールを使用しており、新しい JIRA インストール用のデータベースがデータベースサーバーと同一のコンピュータで実行中の場合、別の名前の(JIRA 4.4.0 には jiradb_440 などが直感的で分かりやすい)新しいデータベースを作成してください。ただし、新しいデータベースと古い JIRA データベースのアクセス権限は同一にしてください。この件に関してサポートが必要な場合は、データベース管理者に相談してください。
組み込み H2 データベースを使用中の場合は、新しいデータベースを作成する必要はありません。
3.4 既存の JIRA アプリケーションの設定を、新しいインストールへ移行する
既存の Jira インストール内で変更した各ファイルについて、新しい Jira インストール内の対応する各ファイルを手動で編集して変更を再適用する必要があります。新しい Jira インストール内にファイルが存在しない場合 (最近の Jira バージョンの osuser.xml
など)、該当ファイルを単純に新しい Jira インストールにコピーします。
以下の表は、最もよく変更されるファイルと、JIRA インストールディレクトリ内の各ファイルの場所を示しています。
ファイル | 「おすすめ」(以前の「スタンドアロン」の JIRA ディストリビューションの保存場所 | 説明 |
---|---|---|
jira-application.properties |
| Location of the JIRA Home Directory and Advanced JIRA Configuration in JIRA 4.3.x and earlier. |
setenv.bat (Windows) または setenv.sh (Linux) |
| |
osuser.xml |
| LDAP を JIRA 統合、Crowd と JIRA を統合、外部のユーザー管理またはユーザー認証のカスタム フォームを使用している場合に修正します。 |
seraph-config.xml |
| Crowd を JIRA と統合した場合に修正します。 |
server.xml |
| 次のような場合に修正します。
|
バージョン固有のアップグレードに関する注意事項には、一般的に変更されるファイルで変更された可能性のあるプロパティに関する詳細も含まれます。
上記のファイル以外にも、アップグレードのプロセスにて以下の設定を考慮・実行する必要があります。
- JIRA をアトラシアンの Crowd と併用する場合 — Crowd と JIRA を併用する場合、「JIRA と Crowd の統合」に記載されているとおり、新しい JIRA が Crowd と通信するように設定します。
- JIRA の新しいホスト名/IP アクセスを許可するように Crowd を設定します。
- 追加メモリを JIRA に割り当てる — 過去に追加メモリを JIRA に割り当てたことがある場合は、新しい JIRA インスタンスに対しても同様に実行します。 詳細は、「JIRA のメモリ容量を増やす」を参照してください。
- プラグイン — 古い Jira にインストールしたプラグインについては、http://plugins.atlassian.com から新しいバージョンの Jira 用のプラグインをダウンロードします。
- 文字エンコード — 文字エンコード (ロケール) が新しい場所と古い場所で同じであることを確認します。 エンコードの互換性がない2つのシステム間で添付ファイルを移動した場合、新しいバージョンの JIRA が正常に動作しない場合があります。
- カスタマイズ — カスタマイズを行った場合(コード、テンプレート、設定ファイルなど)は、これらの変更の互換バージョンを新しい JIRA へコピーします。(ユーザーの古いバージョンをカスタマイズした組織内の開発者は、新しいバージョンに対しても同等の変更のビルドとテストを行って、アップグレード後の JIRA インストールへコピーするファイルをユーザーに提供する必要があります。)
- (オプション) 別のポートで JIRA を実行する— 新しい JIRA が古い JIRA と同一マシン上にインストールされている場合、(古い JIRA の再起動が必要になった場合に備えて) 別々のポートで実行していることを確認することができます。詳細は、「JIRA の TCP ポートの変更」を参照してください。
3.5 JIRA アプリケーションの新バージョンの起動
- 古い JIRA がシャットダウンされていることを確認する : JIRA サーバーが動作中の場合はシャットダウンします。
- 「JIRA の起動」の説明に従って、JIRA の新しいバージョンを起動します。
古い JIRA インストールを再起動しないでください...
新しい JIRA 7.3 インストールと古い JIRA が同じサーバー上にある場合、新しい JIRA インストールと同じ JIRA Home ディレクトリが使用されるように設定されている場合があります。共通の JIRA Home ディレクトリを共有する 2 つの JIRA インストールを実行すると、深刻なデータ破壊が発生する可能性があります。
しかし、アップグレード後の JIRA インストールが期待通りに動作していることを確認するまでは、古い JIRA インストールのすべてのファイル(またはバックアップ コンポーネント)も削除しないことをおすすめします。
3.6 古い JIRA のデータを新しい JIRA アプリケーションにインポートする
古い JIRA のデータを、新しい JIRA にインポートします。
- バックアップしてあった添付ファイル ディレクトリを、新しい Jira の添付ファイル ディレクトリに復元します。(「データの復元」を参照。)
- Jira を起動します。
- セットアップ ウィザードで [Import existing data (既存のデータをインポート)] を選択します。
- [ファイル名] フィールドではエクスポート時 (上記) に取得した XML バックアップファイルを指定します。ZIP ファイルには、
activeobjects.xml
とentities.xml
の 2 つの XML ファイルが含まれています。インポートを成功させるにはこの両方のファイルが入った ZIP ファイルが必要になります。
特に Jira インスタンスが非常に大きい場合は、プロキシ サーバー経由で XML ファイルの復元を実行しないようにしてください。プロキシ サーバーを使うと、タイムアウト エラーが発生する場合があります。 - JIRA に Web ブラウザでアクセスして、古い JIRA のときと同じユーザー名でログインします。
- すべてのプロジェクトと課題がインポートされていて、すべての機能が正常に動いていることをさっと確認します。ページのフッター部分で新しい JIRA のバージョンを確認します。
4. 4. 移行後の確認事項と作業
新しい JIRA アプリケーションのインスタンスを起動したあと、以下の確認と作業を行うことを強く推奨します。
- たとえ JIRA アプリケーションが正常に動作しているように見えても、 エラーメッセージがないか サーバーのログ を確認します。自己解決できないエラーがある場合、サポート ケースを作成し、ログファイルを添付してください。当社がエラーの対処方法をご案内します。
- 以前、外部ユーザー管理を使用していた場合は、新しい JIRA アプリケーションのインスタンスで、それを有効にします。
- アップグレード時にサーバーも変更した場合は、JIRA 管理 セクション内から、インデックスや添付ファイル、バックアップ ディレクトリへのパスを変更します。
- テストの間に E メール機能を無効にしていた場合は、これを有効に戻します。
- 古い JIRA から新しい JIRA へカスタマイズを移行した場合は、そのカスタマイズを十分にテストします。
- JIRA アプリケーションの新バージョン用プラグインをダウンロードした場合は、新バージョンにダウンロードした JAR ファイルをインストールし、そのプラグインに必要なインストールをすべて実行します。
- もしプラグインにプロパティファイルがある場合は、古い JIRA で実施したものと同じ変更を適用します(古いプロパティファイルをコピーしないようにしてください)。
以上です! JIRA アプリケーションの移行またはアップグレードが完了しました。
参考情報
Restoring data
Upgrading JIRA applications
Switching databases