This document describes how to upgrade to JIRA 5.2 manually.
Use this procedure if:
- You are upgrading from:
JIRA Standalone versions 4.0.0 – 4.2.x on Linux or Windows.
or
JIRA WAR version 4.0.0 and later.
or
JIRA version 4.3.0 or later on Solaris (excluding JIRA WAR installations).
AND - You are not changing any of the following:
- The operating system or server hardware that will run JIRA.
- The database that will store JIRA's data.
- The location of JIRA's index and/or attachments paths.
Otherwise, if any of the following points applies to your situation, use the migration procedure (see Migrating JIRA to Another Server) to upgrade JIRA instead:
- You are upgrading from a version of JIRA prior to 4.0.0.
- You are changing the location of your index and/or attachments path for JIRA 5.2.
- You are changing the operating system or server hardware that will run JIRA 5.2.
- You are changing the database or database system that will store JIRA's data.
If you are already using JIRA version 4.3.0 or later on Linux or Windows (excluding JIRA WAR installations), please also note the recommended procedure (see Upgrading JIRA), which might suit your requirements for upgrading to JIRA 5.2.
Please read/perform all steps and sub-steps in consecutive order.
1. 作業を始める前に
- You will need current software maintenance to perform the upgrade. If you are unsure, confirm the following:
- 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.
- Confirm that your operating system, database, other applicable platforms and hardware still comply with the requirements for JIRA 5.2. Newer versions of JIRA may have different requirements and supported platforms to previous JIRA versions.
The End of Support Announcements for JIRA page also has important information regarding platform support for future versions of JIRA. - 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.
- Check for any known issues in the JIRA Knowledge Base.
- 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.
- 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. バックアップ
Before you begin the JIRA upgrade, we strongly recommend that you back up your existing JIRA installation because you cannot roll back a JIRA upgrade (after step 3.3).
2.1 Back up your database
外部データベースのバックアップを実行し(データベースのネイティブなバックアップツールを利用)、バックアップが正常に実行された事を検証します。
- If your database's native backup tools support 'online backups' (i.e. which would typically create a 'snapshot' of your JIRA database while the database is still in use), you can leave JIRA running while you perform the database backup.
- If your database's native backup tools do not allow you to perform an 'online backup' of your JIRA database, you should:
- Prevent users from updating your existing JIRA data (to ensure structural consistency of your database backup) 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.) - Use your database's native backup tools to perform an 'offline backup' of your JIRA database and verify that this backup was created correctly.
- JIRA's 'internal' database is HSQLDB, which should be used for evaluating JIRA only. If you happen to accidentally use the HSQLDB database for a production system, use the Migrating JIRA to Another Server procedure to upgrade JIRA instead of this one.
Inconsistent database backups may not restore correctly! If you are unfamiliar with your database's native backup/restore facilities, then before proceeding, test your database backup's integrity by:
- データベースのバックアップを別の (テスト) システムで復元し、
- 現在の JIRA バージョンのテスト インスタンスをこの復元したデータベースに接続します。
Alternatively, use the Migrating JIRA to Another Server procedure to upgrade JIRA instead.
2.2 Back up your JIRA Home directory
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.3 Back up your attachments directory if located outside your JIRA Home directory
Your attachments directory may be located outside your JIRA Home Directory. If so, it 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. (To do this, 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 the 'Configuring File Attachments' page.)
2.4 Back up your JIRA Installation directory
「JIRA インストールディレクトリ」 は、JIRA がインストールされた時に、JIRA アプリケーション ファイルとライブラリが展開されたディレクトリです。
3.1 JIRA の新バージョンをインストール
First, you must start with a fresh installation of your new JIRA version.
Download and extract the JIRA distribution you require, to a new directory. Do not overwrite your existing JIRA installation. Simply shut this down and install the new JIRA version to a new location.
以下のいずれかのインストール解説に従います:
If you are using JIRA WAR, remember to build your new JIRA web application and deploy it to your server. For specific instructions, read the relevant guide (specific to your application server) within the Installing JIRA WAR section.
3.2 Migrate your existing JIRA configurations over to your new JIRA installation
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.2 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 | 次のような場合に修正します。 |
crowd.properties | atlassian-jira/WEB-INF/classes | | Modified if you have integrated Crowd with JIRA prior to JIRA 4.3. This file should not exist at all in the base installation of JIRA 5.2 but must be copied. |
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.
- Install the JAR file(s) in your new JIRA, and carry out any other required installation for the plugin.
- もしプラグインにプロパティファイルがある場合は、古い JIRA で実施したものと同じ変更を適用します(古いプロパティファイルをコピーしないようにしてください)。
- 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.
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.3 Point your new JIRA to your existing JIRA Home directory
If your new JIRA 5.2 installation is a 'recommended' (not WAR) distribution, you can:
- Open the JIRA Configuration Tool.
- Click the 'JIRA Home' tab.
- Update the 'JIRA Home Directory' field to the path of your existing JIRA Home Directory, which you backed up (above).
For more information about this directory, see JIRA Home Directory.
その他の場合:
- Edit the
jira-application.properties
file located within the <jira-application-dir>/WEB-INF/classes
subdirectory of your new JIRA 5.2 Installation Directory JIRA Installation Directory. - Update the
jira.home
property in this file to the path of your existing JIRA Home Directory, which you backed up (above).
For more information about this directory, see JIRA Home Directory. - Remove the '#' at the beginning of this line (so that JIRA no longer regards this line as a comment).
- Save your updated
jira-application.properties
file.
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.4 Connect your new JIRA to your existing database
Now you need to configure your new JIRA installation to connect to and use your existing database, which was backed up (above).
Once you have performed this step and start your new JIRA server (in step 3.5 below), your JIRA database will be upgraded and it will no longer be compatible with earlier versions of JIRA.
Configure your new JIRA installation to use your existing database. For details refer to the appropriate instructions for your database:
If your new JIRA 5.2 installation is a JIRA WAR distribution and its using a new application server installation, then ensure your database's JDBC driver has been copied across to your new application server. For details, refer to the appropriate instructions:
3.5 JIRA の新しいバージョンを起動させる
- 古い JIRA がシャットダウンされていることを確認する : JIRA サーバーが動作中の場合はシャットダウンします。
- JIRA WAR ディストリビューションを Tomcat 内にインストールした場合、JIRA を再起動する前に Tomcat 作業ディレクトリを削除します。この操作を実行しない場合、JIRA ページを表示した際にエラーが発生する可能性があります。
- 以下に対する 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.
During the startup process, your new JIRA installation will create any required database indexes.
- Visit JIRA in your web browser and log in using a username from your previous JIRA installation. You should be able to log in immediately, without seeing the Setup Wizard.
- すべてのプロジェクトと課題がインポートされていて、すべての機能が正常に動いていることをさっと確認します。ページのフッター部分で新しい JIRA のバージョンを確認します。
4. アップグレード後の確認と作業
新しい JIRA を起動したあとに以下の確認をすることを推奨します。
- 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.
- 外部ユーザーディレクトリを使っていた場合は、新しい JIRA でも有効にします。
- アップグレード時にサーバーも変更した場合は、 JIRA 管理画面でインデックス、添付ファイル、バックアップのディレクトリのパスを変更します。
- テストの間に E メール機能を無効にしていた場合は、これを有効に戻します。
- 古い JIRA から新しい JIRA へカスタマイズしたものを移行した場合は、それを入念にテストします。
- 新しい JIRA のためにプラグインをダウンロードした場合は、ダウンロードした JAR ファイルをインストールして、そのプラグインが必要とするすべてのものをインストールします。
- もしプラグインにプロパティファイルがある場合は、古い JIRA で実施したものと同じ変更を適用します(古いプロパティファイルをコピーしないようにしてください)。
- 新しい JIRA が正しく動いていることが確認できたら、以下の方法で新しいサーバーIDをライセンスに登録します。
- Log in to https://my.atlassian.com.
- 利用したいライセンスを選択します。
- 新しいサーバー ID に変更して、保存します。
- 新しいサーバー上でライセンスを更新します。
以上で、JIRA のアップグレードは完了です!
参考情報
自動エクスポートの無効化
1 Comment
Alan Feldman
May 14, 2013Why the need to manually enter your customized properties into jira-application.properties? Are they not already in jira-config.properties in the existing home directory?
Pardon me if I missed this, but I think you should add something to your docs about checking the browser for error messages when your JIRA startup fails. This happened to me when I forgot to add the mysql connector driver.