Documentation for JIRA 5.0. Documentation for other versions of JIRA is available too.


This document describes how to perform any of the following:

  • migrate/upgrade to JIRA 5.0.x on different server hardware or in a different server environment that entails one or more of the following:
    • JIRA を実行するオペレーティングシステムが変わる
    • インデックスや添付ファイルの保存場所が変わる
    • JIRA のデータを格納するデータベースまたはデータベースシステムが変わる
  • upgrade to JIRA 5.0.x from a version of JIRA prior to 4.0.0 (on the same server hardware and same server environment).
    (warning) Please Note: This is a two-step process. You will need to use this procedure to upgrade to JIRA 4.4.x first before you can upgrade to JIRA 5.0.x. See the JIRA 5.0 Upgrade Notes for details.

(tick) If you are already using:

  • JIRA version 4.3.0 or later on Linux or Windows (excluding JIRA WAR installations), please note the recommended procedure (see Upgrading JIRA), which might suit your requirements for upgrading to JIRA 5.0.x.
  • JIRA version 4.0.0 – 4.2.x (or 4.3.0 or later on Solaris - excluding WAR), or JIRA WAR version 4.0.0 or later, please note the manual procedure (see Upgrading JIRA Manually), which might suit your requirements for upgrading to JIRA 5.0.x.

Upgrading to JIRA 5.0?

If so, please review the JIRA 5.0 Release Notes and JIRA 5.0 Upgrade Notes for important information about this version of JIRA.

On this page:

(warning) Please read/perform all steps and sub-steps in consecutive order.

1. 作業を始める前に

  1. You will need current software maintenance  to perform the upgrade. If you are unsure, confirm the following:
  2. Read the release notes and upgrade guide  for the version of JIRA you are upgrading to. The upgrade guide (in particular) contains important information that may be relevant to your JIRA installation.
    • If you plan to skip a few JIRA versions for your next JIRA upgrade, we strongly recommend that you read the upgrade guides for all major versions between your current version and the version to which you are upgrading. Refer to Important Version-Specific Upgrade Notes for quick links to these guides.
  3. Confirm that your operating system, database, other applicable platforms and hardware still comply with the requirements for JIRA 5.0.x. Newer versions of JIRA may have different requirements and supported platforms to previous JIRA versions.
    (tick) The End of Support Announcements for JIRA page also has important information regarding platform support for future versions of JIRA.
  4. Some anti-virus or other Internet security tools may interfere with the JIRA upgrade process and prevent the process from completing successfully. If you experience or anticipate experiencing such an issue with your anti-virus/Internet security tool, disable this tool first before proceeding with the JIRA upgrade.
  5. Check for any known issues in the JIRA Knowledge Base.
  6. If you have installed any additional JIRA plugins (i.e. not included with JIRA), please verify that they will be compatible with the version of JIRA you are upgrading to. You can find a plugin's compatibility information from the the plugin's home page on the Atlassian Plugin Exchange. 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.
  7. Test first!— We strongly recommend performing your upgrade in a test environment first. Do not upgrade your production JIRA server until you are satisfied that your test environment upgrade has been successful.
    • テスト環境におけるアップグレードで解決できない問題がある場合、我々がサポートできるように弊社サポートサイトで課題を作成して下さい。
    • 本番環境の JIRA サーバのアップグレード中に問題が発生した場合は、サーバをユーザに利用させてはいけません。代わりに、以下を行って下さい:
      • 古い JIRA サーバを引き続き使用して下さい。これによって、本番環境のデータが失われずに済みます。
      • Also create an issue at our support site so that we can help you resolve the problems with production JIRA upgrade.

2. バックアップ

JIRA のアップグレードを開始する前に、既存の JIRA インストールをバックアップする事を強くお勧めします。

2.1 Ensure that users cannot update your existing JIRA data

In subsequent steps, you will be required to export JIRA's database from your existing JIRA installation (via an XML backup) and later restore this backup into a new JIRA installation. To ensure that data consistency in your XML backup is maintained, you must prevent users from updating your existing JIRA data by temporarily restricting access to JIRA. Refer to the Preventing users from accessing JIRA during backups page for more information. (To access this page in the documentation for another version of JIRA, click the documentation link for your version of JIRA at the top of the left Table of Contents column and use the search box below to find this page.)

(warning) Be aware! Inconsistent XML backups cannot be restored!

2.2 データベースのバックアップ

Perform an XML backup of your existing JIRA installation's external database.

  • For large (corporate) JIRA installations, this process may require several hours to complete.
  • The 'embedded database' is the HSQLDB database supplied with JIRA for evaluation purposes only. If you happen to accidentally use the HSQLDB database in a production system, perform an XML backup of this database and continue on with this procedure.

2.3 JIRA Home ディレクトリのバックアップ

Ensure JIRA is shut down before continuing.

The location of this directory is defined within the jira-application.properties configuration file, which is located inside the <jira-application-dir>/WEB-INF/classes directory within your JIRA Installation Directory.

2.4 添付ファイルおよびインデックスの保存ディレクトリが JIRA Home ディレクトリの外にある場合、この二つのディレクトリのバックアップを作成する

Your attachments and index directories may be located outside your JIRA Home Directory. If so, they will also need to be backed up. To confirm the location of:

  • Your attachments directory — refer to Configuring File Attachments page in the documentation for your version of JIRA.
  • Your index directory — refer to Search Indexing page in the documentation for your version of JIRA.

To access these pages, click the documentation link for your version of JIRA at the top of the left Table of Contents column and use the search box below to find either the 'Configuring File Attachments' or 'Search Indexing' page.

JIRA の添付ファイルのバックアップの詳細に関しては、データのバックアップ もご覧ください。

2.5 JIRA インストール ディレクトリのバックアップ

「JIRA インストールディレクトリ」 は、JIRA がインストールされた時に、JIRA アプリケーション ファイルとライブラリが展開されたディレクトリです。

3. 新しいJIRA のインストールと設定

ミッションクリティカルな JIRA サーバーを運用している場合は、事前にテスト環境で (例えば、テスト用の JIRA データベースと JIRA ホームディレクトリのコピーを使用して) 以下の手順を実行してみることを強く推奨します。

3.1 JIRA の新バージョンをインストール

First, you must start with a fresh installation of your new JIRA version.

必要な JIRA ディストリビューションをダウンロードし、新しいディレクトリに解凍します。既にインストールされている JIRA を上書きしてはなりません。既存の JIRA が起動していないことを確認し、新しいバージョンの JIRA を新しい場所にインストールします。

以下のいずれかのインストール解説に従います:

(info) If you are using JIRA WAR, remember to build your new JIRA web application and deploy it to your server. For specific instructions, refer to the JIRA WAR installation page for your application server within the Installing JIRA WAR section.

3.2 新しい JIRA に既存の JIRA ホームディレクトリ(のコピー)を参照させる

If your new JIRA 5.0.x installation is on a new server, copy your existing JIRA Home Directory from the old server to the new server before proceeding.

If your new JIRA 5.0.x installation is a 'recommended' (not WAR) distribution, you can:

  1. Open the JIRA Configuration Tool.
  2. Click the 'JIRA Home' tab.
  3. Update the 'JIRA Home Directory' field as follows:
    • If your JIRA 5.0.x installation is on a new server, update the 'JIRA Home Directory' field to the path of your copied JIRA Home directory.
    • If your JIRA 5.0.x installation is on the same server, update the 'JIRA Home Directory' field to the path of your existing JIRA Home directory.
      (info) For more information about this directory, see JIRA Home Directory.

その他の場合:

  1. Edit the jira-application.properties file located within the <jira-application-dir>/WEB-INF/classes subdirectory of your new JIRA 5.0.x Installation Directory JIRA Installation Directory.
  2. Update the jira.homeproperty in this file to the path of the new JIRA Home Directory:
    • If your JIRA 5.0.x installation is on a new server, update the jira.home property to the path of your copied JIRA Home directory.
    • If your JIRA 5.0.x installation is on the same server, update the jira.home property to the path of your existing JIRA Home directory.
      (info) For more information about this directory, see JIRA Home Directory.
  3. Remove the '#' at the beginning of this line (so that JIRA no longer regards this line as a comment).
  4. Save your updated jira-application.properties file.

(tick) You can also set your JIRA Home Directory's location by defining an operating system environment variable JIRA_HOME. This value of this variable takes precendence over the value of the jira.home property in the jira-application.properties file in your JIRA Installation Directory. See Setting your JIRA Home Directory for details.

3.3 JIRA の新しいバージョンを、新しい空のデータベースに接続させる

You need to create a new, empty database that your new JIRA installation will use to store its data.

お使いのデータベースに対応した以下の「JIRA の ... (データベース名) への接続」の説明に従い、そしてステップ 4 からは以下の黄色の内容に注意してください。

If you are using a database (called jiradb for example) with your existing JIRA installation and the database for your new JIRA installation is running on the same machine or database server, create your new database with a different name (e.g. something intuitive like jiradb_440 for JIRA 4.4.0). However, ensure the new database has identical access permissions to the old JIRA database. Consult your database administrator if you need assistance with this.

(info) 組み込み HSQL データベースを使用中の場合は、新しいデータベースを作成する必要はありません。

3.4 既存の JIRA の設定を、新しい JIRA インストールへ移行する

You may have modified a number of properties within configuration files of your existing JIRA installation.

If so, you need to make the same modifications in your new JIRA installation. However, do not simply copy configuration files from your existing JIRA installation and replace the equivalent files in your new JIRA installation, since the properties in these files may have changed from the old version.

For each file you have modified in your existing JIRA installation, you need to manually edit each equivalent file in your new JIRA installation and re-apply your modifications. If a file is not present in your new JIRA installation (for example, osuser.xml in recent JIRA versions), then simply copy that file over to your new JIRA installation.

以下の表は、修正の多いファイルと、各ファイルのJIRA インストール ディレクトリ内の保存場所を示しています。

ファイル

Location in 'recommended' (formerly 'Standalone') JIRA distributions

JIRA WAR 内の保存場所

説明

jira-application.properties

atlassian-jira/WEB-INF/classes

webapp/WEB-INF/classes

Location of the JIRA Home Directory and Advanced JIRA Configuration in JIRA 4.3.x and earlier.

Any custom property values defined in the jira-application.properties file of your existing JIRA 4.3.x (or earlier) installation must be migrated across to the jira-application.properties file of your new JIRA 5.0.x installation before you start your new JIRA installation.

Upon starting your new JIRA installation, any custom property values in the jira-application.properties file will automatically be migrated across to either the JIRA database or jira-config.properties file. jira.home is the only property of the jira-application.properties file subsequently used by JIRA.

setenv.bat (Windows) または setenv.sh (Linux)

bin

Application Server's bin directory

JIRA メモリの容量を増やす

osuser.xml
(JIRA 4.3.0 以降からのアップグレードの場合は不要)

atlassian-jira/WEB-INF/classes

webapp/WEB-INF/classes

LDAP を JIRA 統合Crowd と JIRA を統合、外部のユーザー管理またはユーザー認証のカスタム フォームを使用している場合に修正します。

seraph-config.xml

atlassian-jira/WEB-INF/classes

webapp/WEB-INF/classes

Crowd を JIRA と統合した場合に修正します。

server.xml

conf

Application Server's conf directory

次のような場合に修正します。

(tick) The version-specific upgrade notes contain details on properties which may have changed in these commonly modified files.

上記のファイル以外にも、アップグレードのプロセスにて以下の設定を考慮・実行する必要があります。

  • Using JIRA with Atlassian's Crowd? — If you are using Crowd with JIRA, configure your new JIRA to talk to Crowd as described in Integrating Crowd with JIRA.
  • 追加メモリを JIRA に割り当てる : 過去に追加メモリを JIRA に割り当てたことがある場合は、新しい JIRA インスタンスに対しても同様に実行します。詳細については、Increasing JIRA Memory を参照してください。
  • Plugins — For any plugins that you had installed in your old JIRA, download the plugin version for your new version of JIRA from the http://plugins.atlassian.com site.
  • Character encoding — Please ensure that character encoding (ie. locale) is the same on the new and old locations. You may have problems with encoding of the file names, if attachments are moved between two system with incompatible encoding.
    (warning) Your new version of JIRA may not function correctly or could encounter problems or errors if these are not implemented.
  • Customisations — If you had made any customisations (code, templates or configuration files), copy over compatible versions of these changes to the new JIRA. (The developers within your organisation who made the customisations to your old version will need to build and test equivalent changes for the new version, and provide you with the files to copy to your upgraded JIRA installation).
  • (Optional) Disabling Email Access — If you need to perform some initial tests on your new JIRA installation, you can disable its email access to prevent unintended emails being sent during testing. Be sure to re-enable email access once any testing is complete.
  • (オプション)別のポートで JIRA を実行する : 新しい JIRA が古い JIRA と同一コンピュータ上にインストールされている場合、別々のポートで実行していることを確認することもできます(古い JIRA の再起動が必要になった場合に備えて)。詳細は、Changing JIRA's TCP Ports を参照してください。

3.5 JIRA の新しいバージョンを起動させる

  1. 古い JIRA がシャットダウンされていることを確認する : JIRA サーバーが動作中の場合はシャットダウンします。
  2. JIRA WAR ディストリビューションを Tomcat 内にインストールした場合、JIRA を再起動する前に Tomcat 作業ディレクトリを削除します。この操作を実行しない場合、JIRA ページを表示した際にエラーが発生する可能性があります。
  3. 以下に対する JIRA の新しいバージョンを起動します。
    • 'Recommended' distributions — follow the Starting JIRA instructions.
    • WAR distributions — follow the instructions for starting JIRA for your application server within the Installing JIRA WAR section.
      (info) During the startup process, your new JIRA installation will create any required database indexes. If you created any custom database indexes, please check them afterwards and remove any that duplicate the indexes added by JIRA.

古い JIRA インストールを再起動しないでください...

If your new JIRA 5.0.x installation is on the same server as your old one, it may still be configured to use the same JIRA Home directory as your new JIRA installation. Running two separate JIRA installations which share a common JIRA Home directory can lead to serious data corruption.

しかし、アップグレード後の JIRA インストールが期待通りに動作していることを確認するまでは、古い JIRA インストールのすべてのファイル(またはバックアップ コンポーネント)も削除しないことをおすすめします。

3.6 古い JIRA のデータを、新しい JIRA にインポートする

After you have successfully started your new JIRA installation, you will need to import the data from your old instance into the new instance. You will need the backup file of data from your old JIRA that you created earlier in these instructions (above).

To import your old JIRA data into your new JIRA,

  1. Access JIRA via your web browser. You will see the Setup Wizard.
  2. Click the 'import your existing data' link.
  3. The 'Import Existing Data' page will be displayed.
    • In the 'File name' field, specify the XML backup file you created previously.
  4. Restore the attachments directory that you backed up previously, into the attachments directory of your new JIRA. (See Restoring Data.)
    (info) It is recommended that you avoid passing through a proxy when performing an XML restore, especially if your JIRA instance is very large. Using a proxy may cause timeout errors.
  5. JIRA に Web ブラウザでアクセスして、古い JIRA のときと同じユーザー名でログインします。
  6. すべてのプロジェクトと課題がインポートされていて、すべての機能が正常に動いていることをさっと確認します。ページのフッター部分で新しい JIRA のバージョンを確認します。

4. アップグレード後の確認と作業

新しい 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 in https://support.atlassian.com/ja, attach your log file and we will advise you on the errors.
  2. 外部ユーザーディレクトリを使っていた場合は、新しい JIRA でも有効にします。
  3. アップグレード時にサーバーも変更した場合は、 JIRA 管理画面でインデックス、添付ファイル、バックアップのディレクトリのパスを変更します。
  4. テストの間に E メール機能を無効にしていた場合は、これを有効に戻します。
  5. 古い JIRA から新しい JIRA へカスタマイズしたものを移行した場合は、それを入念にテストします。
    1. 新しい JIRA のためにプラグインをダウンロードした場合は、ダウンロードした JAR ファイルをインストールして、そのプラグインが必要とするすべてのものをインストールします。
    2. もしプラグインにプロパティファイルがある場合は、古い JIRA で実施したものと同じ変更を適用します(古いプロパティファイルをコピーしないようにしてください)。

おめでとうございます!JIRA の移行/アップグレードが完了しました。

参考情報

自動エクスポートの無効化
データのリストア
JIRA のアップグレード
アプリケーションサーバーを Apache Tomcat に変更
データベースの切り替え

  • ラベルなし