フォールバック手法による Jira アプリケーションのアップグレード

This page describes how to upgrade Jira 4.4.x or later in a way that allows you to safely roll back to your previous system if the upgrade process takes longer than expected, or if you encounter issues. This method is especially useful for enterprise environments and for organizations where Jira is mission-critical for the business. You can also use this method so you have a fallback option if you are performing a complex system change, such as changing the operating system that will run Jira, the database that will store Jira's data or the location of Jira's index and/or attachments paths.

ここで説明する手順は、極めて安全なアップグレード手法を提供するべく設計されており、従ってデータベース管理業務に関する高度な知識が必要です。当社では、アップグレードに際しては以下の分野のリソースおよび専門知識を活用できるようにしておくことを推奨します:

• データベース管理者 – 本番環境レベルでのデータベース管理全般 (バックアップ、作成、削除、復元など)
• Jira application administrator - for general application administration and upgrade managment (i.e. Jira SME, user with System Administrator privileges and deep understanding of application and associated dependencies within your organization.)
• システム/ネットワーク管理者 – システムおよびネットワークの管理 (プロキシサーバー、DNSの変更、モニタリング、仮想マシン、ハードウェアなど)

This upgrade process also requires you to make backups of your database, which can be time-consuming. Customers with large Jira environments should plan for four hours of downtime. If you know your system takes several hours to re-index, you might want to allocate more than four hours for the upgrade.

See Upgrading Jira applications for more information on the methods you can use to upgrade Jira.

始める前に

アップグレードプロセス中に問題が発生した場合は、弊社サポートサイトで課題を作成することで、アップグレードに伴う問題解決のサポートを受けることができます。最初に以下の手順をテストとしてのみ実行することを強くお勧めします。それによって、何らかの複雑な問題 (カスタマイズした設定やアドオンに伴う問題) がある場合に事前にそれを認識することができるため、システムのダウンタイムを最小化できます。

1. 本番環境のインスタンスにおけるアップグレード準備作業

アップグレード準備作業に入る際は、本番環境のシステムに対して重要な変更 (プラグインのアップグレード、カスタマイズなど) を行う処理をすべて停止します。本番環境システムを可能な限り安定化することにより、新しいバージョンのテストが簡単になります。

It's also a good idea to let your users know about planned downtime, either through email or by using Jira's announcement banner.

2. Set up a proxy server

Before beginning the upgrade process set up a reverse proxy, such as a load balancer. The proxy server allows you to redirect users to a different Jira server without having to wait for a DNS change - this change will be invisible to the end-user.  If, at any point during the upgrade process, you encounter issues you can't resolve and you need to rollback to your existing Jira instance, simply restart your existing Jira instance and reconfigure the proxy server to point to the old server.

本番環境用サーバーに関連して、モニタリング、API 呼び出し (SOAP、REST、CLI 等)、またはスクリプトを使用する場合は、それらをアップデートして新たに設定したプロキシ情報を反映させます。

Apache の設定に関する詳細情報は以下のドキュメントをご覧ください :

• Jira と Apache の統合
• SSL を利用して Jira と Apache を統合する方法

3. Disable the old Jira production instance and start the new instance

Before disabling your old Jira production instance, identify the location of your attachments and index directories. If they are located outside of your Jira home directory, you will back them up manually later during the upgrade process. These pages describe how to find out where these directories are located in your environment:

• Your attachments directory — Refer to the Configuring file attachments page for your version of Jira.
• Your index directory — Refer to the Search indexing page for your version of Jira.

If your attachments and index directories are located outside of the Jira home directory, note their location so you can easily find them later.

After you've located the attachments and index directories, disable the old Jira production instance so you can perform a database backup:

1. Shut down your old production Jira instance (for example, by executing either the /bin/stop-jira.sh or \bin\stop-jira.bat file in your Jira application installation directory, or by stopping the Jira service).
2. Using your database's native backup tools, perform a backup of the data in your old production Jira instance. See Backing up data.

3. 本番環境用データベースの最新のコピーを、新しい本番環境用のデータベースに設定します。
   
   

   Make sure that the database set up for the new production version of Jira is clearly distinguishable from the database backup of your old production Jira, and that the new production instance is not configured to connect to the old production database.

4. Synchronize the Jira attachment directories:
   1. 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.
   2. 設定ファイルに記録されているディレクトリに移動して、別のディレクトリにそのバックアップを作成します。

   3. If the attachments and index directories are located outside of your Jira home directory, you must back them up separately. (See the beginning of this task for information on how to find these files.)

      Also refer to Backing up data for more information about backing up attachments in Jira.

   4. Replace the Jira home directory (and the attachment and index directories, if separate from the Jira home directory) in the new Jira production environment with the backups you made of the old production directories.

5. Start the new version of Jira in your new production environment. When you start this version, Jira will upgrade your data and may perform a re-index. When the re-indexing is complete, verify that your data is present and that there are no issues with the system.

    

   JIRA インスタンスのサイズによっては、インデックスの再構築に数時間かかることがあります。お客様のインスタンスにおいてインデックス構築時間が長いことが分かっている場合は、ダウンタイムの予定にそれを反映させてください。

6. Reconfigure the proxy server you set up in step 2 so that the new version of Jira becomes your production instance. Make sure to let your users know about the new instance (including the new domain name) and any changes that might affect them.

新しい本番環境において何らかの問題が発生した場合は、それが解決されるまで単にプロキシサーバー設定を元に戻して元の本番環境のインスタンスを再度使用できるようにします。

4. ポストアップグレードのチェックおよびタスク

It is strongly recommended that you perform the following checks and tasks after you have started your new instance of Jira:

1. Check your server logs for error messages, even if Jira appears to be running correctly. If there are any errors there that you cannot resolve, create a support case, attach your log file, and we will advise you on the errors.
2. If you were previously using External User Management, enable it in the new Jira instance.
3. If you changed machines when upgrading, change the paths to the indexes, attachments and backup directories, from within the Administration section of Jira.
4. テストの間に E メール機能を無効にしていた場合は、これを有効に戻します。
5. If you migrated any customizations from your old Jira to the new Jira, ensure that they are tested thoroughly.
   
   1. If you had downloaded plugins for the new version of Jira, install the downloaded JAR file(s) in your new Jira version and carry out any other required installation for the plugin.
   2. もしプラグインにプロパティファイルがある場合は、古い JIRA で実施したものと同じ変更を適用します（古いプロパティファイルをコピーしないようにしてください）。
6. 新しい JIRA が正しく動いていることが確認できたら、以下の方法で新しいサーバーIDをライセンスに登録します。
   
   1. Log in to https://my.atlassian.com.
   2. 利用したいライセンスを選択します。
   3. 新しいサーバー ID に変更して、保存します。
   4. 新しいサーバー上でライセンスを更新します。

Once you have confirmed the availability of compatible versions, you should upgrade your plugins after successfully upgrading Jira. This can be done via the 'Plugin Repository' in your Administration Console. It is recommended that you re-index Jira after upgrading your plugins.

Congratulations! You have completed your Jira migration/upgrade.