Page tree

Contents


はじめに

このドキュメントでは、既存の Jira をアップデートする基本的な手順について説明します。
クリーンインストールとは異なり、アップデートではお使いの環境にあわせた調整が必要になることがあります。 ここで紹介する手順を参考に、環境に合わせた作業を行なってください。

困ったときは

アップデート作業で困ったことがありましたら、テクニカルFAQ  で検索してください。
また、弊社から購入されたお客さまは、お問い合わせに ヘルプデスク をご利用いただけます。


既存の Jira は、以下の環境にインストールされていると想定します。

Jira のバージョン

7.2.13 (Linux 64 Bit Installer版)

プログラムディレクトリ

/opt/atlassian/jira (インストーラのデフォルト設定を使用)

データディレクトリ

/var/atlassian/application-data/jira (インストーラのデフォルト設定を使用)

コンテキストルート 
(URL でサーバー名に続く文字)
/jira

インストールを実行するユーザー

root

Jira 稼働ユーザー

jira

DB

Jira と同一のコンピュータにインストールされた PostgreSQL を利用(今回は jira を使用)

javaJira に同梱の JRE を使用
WEB サーバー

Jira に同梱の Tomcat を使用

サーブレットコンテナ

Jira に同梱の Tomcat を使用

起動方法

サービスとして登録し、自動起動する。

この環境を、2018年5月時点でエンタープライズ版最新の Jira 7.6.5 にアップデートします。

1. 既存データのバックアップと準備


アップデート作業前に、必ず以下をご確認ください

  1. ライセンスが有効か?
    いまご使用いただいている Jira に有効なライセンスが設定されていることをご確認ください。ライセンスが失効しているか、有効なライセンスキーがわからなくなっているときは、弊社までお問い合わせください

  2. バージョンアップ後のJIRAと、JAVAなどの互換性の確認
    ご使用中のオペレーティングシステムとデータベース、JAVA などがバージョンアップ予定の Jira で利用できることを確認してください。必要なバージョンは、サポートプラットフォームのページでご確認いただけます。

  3. 更新前とアップデート後の Jira のバージョンの組み合わせについて
    バージョン番号の二桁目(x.y.z の y)を飛ばさないようにバージョンアップをお願いしています。 そのため、お使いの Jira のバージョンと、アップデートしたい Jira のバージョンの組み合わせによっては、一度にはアップデートできない場合があります。
    その場合は、アップデートがサポートされているバージョンをいくつか経由して、目的のバージョンまでアップデートする必要があります。 詳細については弊社までお問い合わせください。 

  4. シングルサインオン設定をされている場合
    バージョンアップ後、シングルサインオンの設定ファイルが初期値になります。 シングルサインオンのために seraph-config.xml をカスタマイズしている場合は、手動で移行する必要があります。

  5. セキュリティソフトの有無
    ウィルス対策ソフト、セキュリティソフトが動作していると、アップデートが失敗することがあります。これらが原因でアップデートに失敗していると思われるときは、一時的にウィルス対策ソフトやセキュリティソフトを無効に設定してください。

  6. リハーサルの実施
    実際に運用しているJIRAをアップデートする前に、テスト環境でアップデートのリハーサルを行なってください! テスト環境でのリハーサルを行い、十分に動作確認をされた後に、実際に運用しているJIRAをアップデートしてください。

まず最初に、作業が失敗した場合にデータを復旧できるようにするため、Jira のバックアップを作成します。 また、このバックアップ操作は、サーバ移設も伴う場合に、新しい Jira にデータを移行時に使用します。
作成したバックアップに漏れがあると、新しい Jira にデータを移行したり、データの復旧ができなくなったりする可能性があります。 作業漏れがないように注意するとともに、作成したバックアップは安全な場所にコピーを保存しておくようにお願いします。

1-1. Jira のバックアップを作成

ここでは、Jira 標準機能を利用する方法と、データベースのバックアップ機能を利用する方法の2通りをご案内します。
なお、Jira を仮想サーバー上で動作させている場合は、仮想サーバー単位でバックアップを作成していただくのが安全です。

バックアップ方法についてのご注意

Backing Up Data (英語) に記載されています通り、
Jira 標準機能の XML バックアップは、実施中に Jira サーバーへ大きな負荷がかかることや、Jira をロックせずに実施するため、バックアップデータの整合性が保証できないことから、Atlassian では推奨しておりません。

① Jira のメニューからバックアップを作成する

Jira よりXMLバックアップを作成する

管理者ユーザーでJIRAにログインし、画面右上の歯車アイコンより「システム」画面を開きます。左側メニューの「システムのバックアップ」をクリックします。

Jira データのバックアップ画面が開きます。「ファイル名」テキストボックスに作成するバックアップファイルの名前を指定して「バックアップ」ボタンをクリックします。

バックアップが終了すると、作成したバックアップファイルの名前がフルパス名で表示されます。
ファイル名の拡張子として、自動的に「.zip」が付加されます。 バックアップファイルは、表示されているディレクトリ内に作成されます。
下の画面の例では「/var/atlassian/application-data/jira/export」です。

添付ファイルをバックアップする

添付ファイルは作成したバックアップファイルに含まれないため、添付ファイルはディレクトリごとコピーします。
ここでは、作成したバックアップファイルと添付ファイルを保存用ディレクトリにコピーする方法を説明します。
バックアップの保存先ディレクトリとして ~/work/Backup_Jira (別の位置でも構いません)を作成し、そのあとバックアップファイルと添付ファイルをコピーします。 添付ファイルはディレクトリごとコピーします。

# mkdir -p ~/work/Backup_Jira                                             ←バックアップの保存先ディレクトリを作成
# cd /var/atlassian/application-data/jira/export/                         ←バックアップ出力先にカレントを移動
# cp Backup-1Oct2014-0920.zip ~/work/Backup_Jira/                         ←バックアップの圧縮ファイルを保存先ディレクトリへコピー
# cp -r /var/atlassian/application-data/jira/data/ ~/work/Backup_Jira/    ←添付ファイルを含むディレクトリをコピー
# ls -l ~/work/Backup_Jira/                                               ←コピーしたファイルを確認
合計 56
-rw-r--r--. 1 root root 56612  5月  2 12:04 Backup_20180502.zip
drwxr-xr-x. 3 root root    25  5月  2 12:05 data


② データベースのツールでバックアップを作成する (PostgreSQL)

Jira の使用しているデータベースをバックアップします。ここでは PostgreSQL を例にして手順を説明します。その他のデータベースシステムをご利用の場合は、データベースシステムのマニュアルをご確認ください。

PostgreSQL のバックアップには、pg_dump コマンドを使用します。以下に pg_dump コマンドでバックアップを作成する例を挙げます。この例では、バックアップファイル内にデーターベースを復元するためのコマンドが出力されます。
データ量が膨大な場合などは、アーカイブ形式でバックアップを作成することもできます。詳細は pg_dump コマンドのリファレンスなどを参考にしてください。

# su - postgres                 ←PostgreSQLを使うためにユーザーを変更
-bash-4.1$ pwd                  ←カレントディレクトリを確認
/var/lib/pgsql
-bash-4.1$ mkdir work           ←バックアップ先ディレクトリを作成(1)
-bash-4.1$ cd work
-bash-4.1$ mkdir Backup_Jira   ←バックアップ先ディレクトリを作成(2)
-bash-4.1$ cd Backup_Jira
-bash-4.1$ pg_dump jira > jira_backup    ←pg_dumpコマンドでデータベースのバックアップを作成
-bash-4.1$ ls -l                            ←作成したバックアップを確認
合計 472
-rw-r--r--. 1 postgres postgres 482936  5月  2 12:11 jira_backup

tar コマンド等を利用して、Jira のホームディレクトリのアーカイブファイルを作成します。

# cd ~/work/Backup_Jira/ 
# tar -cvf Backup_20180502.tar /var/atlassian/application-data/jira    ←tarコマンドでJIRAホームディレクトリのアーカイブを作成
# ls -l                            ←作成したアーカイブファイルを確認
合計 240848
-rw-r--r--. 1 root root 246568960  5月  2 12:14 Backup_20180502.tar
-rw-r--r--. 1 root root     56612  5月  2 12:04 Backup_20180502.zip
drwxr-xr-x. 3 root root        25  5月  2 12:05 data


1-2.  Jira アップデートチェックを実施する

Jira の持っている The Universal Plugin Manager には、インストールされているプラグインがアップデート予定のバージョンでも利用できる機能があります。
この機能を使って、ご使用中のプラグインが新しいバージョンでもご利用できるか確認できます。

管理者ユーザーで Jira にログインし、画面右上の歯車アイコンより「アドオン」画面を開きます。

画面下側の「JIRA update check」をクリックします。

「アップデートの互換性チェック」ドロップダウンリストで、アップデート予定のバージョンを選択します。
ここでは2018年5月時点のエンタープライズ版最新である「7.6.5」を選択しました。バージョンを選択できたら「チェック」ボタンをクリックします。

ご使用中のプラグインについて、互換性に問題のあるもの、問題のないものなどに分類されて表示されます。簡単な対応方法も表示されますので、参考にして対応を行なってください。

基本的に、互換性のないプラグインの場合はいったん無効にしてからアップデートを行うことになります。使用予定のバージョンに対応したプラグインがあるかは、各プラグインの配布ページ、作者にご確認ください。

2. アップデートインストール

バックアップの作成、アップデートチェックを行い、バージョンアップに問題がなければ実際のインストール作業を行います。

2-1. 新バージョンのインストールファイルを入手する

新規に Jira をインストールしたときと同様に、Atlassianのサイト からインストール用ファイルをダウンロードします。
お使いの環境にあわせて、Linux 32 Bit 版 または Linux 64 Bit 版をダウンロードして適当なディレクトリに保存してください。

2-2. 設定ファイルの確認

インストール時と同様にコマンドプロンプトからインストーラを実行するとアップデートが実行されます。
アップデートを行うとき、Jira のインストーラは既存の XML ファイルなどから設定を読み取り、アップデート後の設定ファイルに反映します。
ただし、反映可能な設定は以下のものに限られています。

  • server.xml に記載されているポート番号(コンテキストルートは引き継がれません)
  • setenv.sh に記載されている以下の環境変数
    • JVM_SUPPORT_RECOMMENDED_ARGS …… JVM(Java仮想マシン)に与える引数
    • JVM_MINIMUM_MEMORY …… JVMの使用する最小メモリサイズ
    • JVM_MAXIMUM_MEMORY …… JVMの使用する最大メモリサイズ
    • JIRA_MAX_PERM_SIZE…… JVMのPermanent領域の最大サイズ

これら以外の方法で設定を変更している場合は、アップデート完了後に手動で設定を反映させてください。

2-3. アップデートインストールを実行する

実際にアップデートインストールを実行したときの例を以下に示します。

ダウンロードしたインストーラファイルに実行権限を付与します。ls -lコマンドでファイルの権限を表示したときに、実行権限“x”が付いていることを確認してください。

# chmod 744 atlassian-jira-software-7.6.5-x64.bin
# ls -l atlassian-jira-software-7.6.5-x64.bin
-rwxr--r--. 1 root root 342165555  5月  2 11:36 atlassian-jira-software-7.6.5-x64.bin

インストーラを実行してアップデートを開始します。最初にインストールを続けてもいいか確認されるので、[Enter]キーを押して続けてください。

# ./atlassian-jira-software-7.6.5-x64.bin
Unpacking JRE ...
Starting Installer ...

This will install JIRA Software 7.6.5 on your computer.
OK [o, Enter], Cancel [c]

次にインストール方式を選択します。アップグレードインストールを行うので、[Enter]キーを押してください。

Choose the appropriate installation or upgrade option.
Please choose one of the following:
Express Install (use default settings) [1], Custom Install (recommended for advanced users) [2], Upgrade an existing JIRA installation [3, Enter]

インストール先ディレクトリの確認を行います。インストール時に変更していなければ、そのまま[Enter]キーを押してください。

Existing installation directory:
[/opt/atlassian/jira]

インストーラによるJIRAホームディレクトリのバックアップを行うか確認します。バックアップを作成してインストールを続けたいので[Enter]キーを押してください。

Back up JIRA home directory
The upgrade process will automatically back up your JIRA installation
directory. You can also choose to back up your existing JIRA home directory.
Both directories are backed up as zip archive files in their respective
parent directory locations.

We strongly recommend choosing this option in the unlikely event that you
experience problems with the upgrade and may require these backups to
restore your existing JIRA installation.

If you have many attachments in your JIRA home directory, the zip archive of
this directory may consume a significant amount of disk space.
Back up JIRA home directory?
Yes [y, Enter], No [n]

設定ファイルの変更内容を確認します。インストーラが変更されたファイル、削除したファイル、追加されたファイルを検出し、リスト表示します。内容を確認して[Enter]キーを押してください。

Checking for local modifications.

List of modifications made within JIRA directories.

The following provides a list of file modifications within the
atlassian-jira directory.
Modified files:
        conf/server.xml
Removed files:
        (none)
Added files:
        (none)
[Enter]

アップデートインストールを実行してもいいか、最終確認を行います。[Enter]キーを押してインストールを実行してください。

Checking if your instance of JIRA Software is running
Upgrade check list
Back up your external database
We strongly recommend you back up your JIRA Software database if you have
not already done so.

Please refer to the following URL for back up guidelines:
http://docs.atlassian.com/jira/jadm-docs-076/Backing+up+data

Check plugin compatibility
Check that your non-bundled plugins are compatible with JIRA Software 7.6.5.

For more information see our documentation at the following URL:
http://docs.atlassian.com/jira/jadm-docs-076/Upgrading+JIRA+applications

Please ensure you have read the above checklist before upgrading.
Your existing JIRA installation is about to be upgraded! Do you want to proceed?
Upgrade [u, Enter], Exit [e]

アップデートインストールが実行されます。
Jira を起動するか聞かれるので好みに合わせて選択してください。

Your instance of JIRA is currently being upgraded.
Checking if JIRA has been shutdown...
Backing up the JIRA installation directory

Backing up the JIRA home directory

Deleting the previous JIRA installation directory...

Extracting files ...


Please wait a few moments while JIRA Software is configured.
Installation of JIRA Software 7.6.5 is complete
Start JIRA Software 7.6.5 now?
Yes [y], No [n, Enter]

2-4. インストール後の動作確認

Jira を起動するとブラウザからアクセスできるようになります。

ご注意ください

server.xml に設定していたコンテキストルートは引き継がれていません。
ブラウザーで Jira にアクセスするときは、http://(サーバー名 または IPアドレス):(ポート番号) を開いてください。 または、server.xml を変更後、Jira を再起動してください。

Jira にアクセスして、以前と同じ ID とパスワードでログインできることを確認します。

アップグレード完了の画面が表示されます。
「JIRAへ移動」をクリックします。 

つづけてダッシュボード画面が表示されます。

アドオンの管理画面を開き、必要なアドオンが利用できるようになっていることを確認します。

2-5. アプリケーションアクセス権限の確認

既存のユーザーがJIRA Softwareの機能を利用できるかを確認します。

JIRA管理者権限でJIRAへログインし、画面右上の歯車アイコンより「アプリケーション」を選択します。

左側メニューの「アプリケーションアクセス」をクリックし、JIRA Softwareを利用できるグループを確認します。
利用できるグループを追加する場合は、「グループを選択」より追加をお願いします。
「既定」チェックボックスにチェックを入れた場合は、新規ユーザー作成時にチェックしたグループに自動的に所属します。


アプリケーションアクセス設定に関しての詳細は、 Jira Software ユーザーとアプリケーションアクセス設定 をご覧ください。



その他の操作も行なって、以前と同様に Jira が利用できることを確認してください。
リハーサル環境で正常稼働が確認できたら、本番環境へも同様にアップデートインストールを行います。

最終的に、本番環境で正常に動作していることが確認できたらアップデート作業は終了です。

This page has no comments.