手動による JIRA アプリケーションのアップグレード
JIRA 7.0 より前のバージョンからアップグレードする場合、「 移行ハブ」を参照してください。JIRA 7.0 のリリースではユーザー管理、アプリケーション アクセスとログイン権限、および JIRA インストールセットアップに影響を与える機能が含まれていました。したがって、アップグレード前に要件と影響について理解しておくことが非常に重要です。移行ハブには、このすべての情報が便利な１つのスペースにまとめられています。
1. 始める前に
- 新しいバージョンについて読む - アップグレードしようとしている JIRA バージョンのリリースノートやアップグレードに関する注意事項を確認します。JIRA サーバーのリリースノートを参照してください。アップグレード中にいくつかの JIRA バージョンをスキップする予定がある場合は、現在のバージョンから目的のアップグレードバージョンの間のすべてのメジャーバージョンに関するアップグレードガイドを読むことを強くお勧めします。
- ライセンスの確認 – お客様の ライセンスサポート期間 が有効期間内であることを確認します。
- 既知の問題の確認 - 影響を与える新しいバージョンの問題点を検索するには、JIRA ナレッジベースを利用します。
- 互換性の確認:
- お客様のオペレーティングシステム、データベース、その他の利用可能なプラットフォームおよびハードウェアが JIRA 7.3 の 要件 を満たしていることを確認します。サポート終了のお知らせのページにも、今後リリースする JIRA のバージョンにおけるプラットフォームサポートに関する重要な情報が記載されています。
- Jira のプラグイン (Jira にデフォルトで含まれない機能) をインストールした場合は、アップグレード先の Jira のバージョンとの互換性を確認する必要があります。プラグインの互換性の情報については、Atlassian Marketplace のプラグインのホームページをご参照ください。
- ウィルス対策ツールやインターネットセキュリティーツールの中には JIRA アップグレードの障害となるものがあり、アップグレードが成功しないことがあります。ウィルス対策ツールやインターネットセキュリティーツールに関して、お客様がそのような経験をお持ちであるか、またはそのような事態に陥る恐れがある場合は、JIRA のアップグレード作業に入る前にまずこれらのツールを無効にしてください。
- JIRA の新しいバージョンの事前ステージングとテスト - 最初に、テスト環境でアップグレードを実行することを強くお勧めします。 テスト環境におけるアップグレードが成功しない限り、本番環境の JIRA サーバをアップグレードしないでください。
2. バックアップ
JIRA のアップグレードを開始する前に、既存の JIRA インストールをバックアップする事を強くお勧めします。
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.propertiesfile 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 ホームディレクトリ外にある場合は、この２つのディレクトリのバックアップをそれぞれ作成する必要があります。ご使用の実装でこれらのディレクトリの場所を見つける方法については、次のページで説明しています。
- 添付ファイル ディレクトリ — ご使用の JIRA バージョンのドキュメントで、 「ファイル添付の設定」ページを参照してください。
- インデックスディレクトリ — ご使用の JIRA バージョンのドキュメントで、「インデックス作成の検索」ページを参照してください。
JIRA の添付ファイルのバックアップに関する詳細は、「データのバックアップ」もご覧ください。
2.5 JIRA インストール ディレクトリのバックアップ
「JIRA インストールディレクトリ」 は、JIRA がインストールされた時に、JIRA アプリケーション ファイルとライブラリが展開されたディレクトリです。
3. 新規 JIRA インストールのセットアップ
「ミッションクリティカル」な JIRA サーバーを実行中であれば、本番環境でアップグレードを行う前に、本ガイドの残りのステップをテスト環境で行う事を強くお勧めします (例えば、別のテスト用 JIRA データベースと、お使いの JIRA ホームディレクトリのコピーの利用)。
3.1 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 インストール内にファイルが存在しない場合 (最近の 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 用のプラグインをダウンロードします。
- 文字エンコード — 文字エンコード (ロケール) が新しい場所と古い場所で同じであることを確認します。 エンコードの互換性がない２つのシステム間で添付ファイルを移動した場合、新しいバージョンの 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. ポストアップグレードのチェックおよびタスク
新しい JIRA を起動したあとに以下の確認をすることを推奨します。
- JIRA が正常に稼働しているように見えても、 サーバー ログにエラーメッセージがないか確認します。自己解決できないエラーがある場合、サポート ケースを作成し、ログファイルを添付してください。当社がエラーの対処方法をご案内致します。
- 前に外部ユーザー管理機能を使用していた場合は、新しい JIRA インスタンスでも有効にします。
- アップグレード時にマシンも変更した場合は、JIRA の管理セクション内でインデックス、添付ファイル、バックアップのディレクトリのパスを変更します。
- テストの間に E メール機能を無効にしていた場合は、これを有効に戻します。
- 古い JIRA から新しい JIRA へカスタマイズしたものを移行した場合は、それを入念にテストします。
- 新しい JIRA バージョンのためにプラグインをダウンロードした場合は、新しい JIRA バージョンにダウンロードした JAR ファイルをインストールして、そのプラグインが必要とするその他のすべてのインストールを実行します。
- もしプラグインにプロパティファイルがある場合は、古い JIRA で実施したものと同じ変更を適用します（古いプロパティファイルをコピーしないようにしてください）。
- 新しい JIRA が正しく動いていることが確認できたら、以下の方法で新しいサーバーIDをライセンスに登録します。
- Log in to https://my.atlassian.com.
- 利用したいライセンスを選択します。
- 新しいサーバー ID に変更して、保存します。
- 新しいサーバー上でライセンスを更新します。
おめでとうございます！JIRA の移行／アップグレードが完了しました。
参考資料
Restoring data
Upgrading JIRA applications
Switching databases