Page tree

Contents

 

はじめに

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

ご注意ください

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


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

Confluenceのバージョン6.6.13 (Linux 64 Bit Installer 版)

プログラムディレクトリ

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

データディレクトリ

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

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

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

root

Confluence 稼働ユーザー

confluence

DB

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

javaConfluence に同梱のJREを使用
WEBサーバーConfluence に同梱のTomcatを使用
サーブレットコンテナConfluence に同梱のTomcatを使用

起動方法

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

この環境を、Confluence 6.15.7 にアップデートします。

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

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

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

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

  3. 更新前とアップデート後のConfluenceのバージョンの組み合わせについて
    お使いの Confluence のバージョンと、アップデートしたい Confluence バージョンの組み合わせによっては、一度にはアップデートできない場合があります。
    詳細はAtlassianドキュメントをご確認ください。

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

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

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

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

1-1 Confluenceのバックアップを作成

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

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

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

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

管理者ユーザーで Confluence にログインし、Confluence 管理者画面を開きます。「一般設定」→「バックアップと復元」 をクリックします。


Confluence データのバックアップ画面が開きます。「バックアップ フォルダーにアーカイブ」にチェックを入れると、「バックアップの管理」メニューで設定しているバックアップパスへ保存されます。

また、「バックアップ フォルダーにアーカイブ」にチェックを入れない場合は、一時ディレクトリ(<Confluenceホームディレクトリ>/temp/)に保存されます。

添付ファイルをバックアップする場合は、「添付ファイルをバックアップ」にチェックを入れます。最後に「バックアップ」をクリックします。

バックアップが終了すると、作成したバックアップファイルの名前がフルパス名で表示されます。

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

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

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

# su - postgres          ←PostgreSQLを使うためにユーザーを変更
-bash-4.2$ pwd           ←カレントディレクトリを確認
/var/lib/pgsql
-bash-4.2$ mkdir work              ←バックアップ先ディレクトリを作成(1)
-bash-4.2$ cd work
-bash-4.2$ mkdir Backup_Conf       ←バックアップ先ディレクトリを作成(2)
-bash-4.2$ cd Backup_Conf
-bash-4.2$ pg_dump confluence > confluence_backup    ←pg_dumpコマンドでデータベースのバックアップを作成
-bash-4.2$ ls -l                            ←作成したバックアップを確認
合計 928
-rw-r--r--. 1 postgres postgres 948219  9月  6 15:56 confluence_backup

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

# mkdir -p ~/work/Backup_Conf/         ←保存先ディレクトリを作成
# cd ~/work/Backup_Conf/ 
# tar -cvf Backup-2019-0906.tar /var/atlassian/application-data/confluence   ←tarコマンドでConfluenceホームディレクトリのアーカイブを作成
# ls -l                            ←作成したアーカイブファイルを確認
合計 300380
-rw-r--r--. 1 root root 307589120  9月  6 16:02 Backup-2019-0906.tar

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

Confluence のアプリを管理するツールである Universal Plugin Manager で、インストールされているアドオンがアップデート予定のバージョンでも利用できるかを確認する。

Confluence アップデートチェックは、 歯車 >「アドオン」よりできます。


アドオンの管理画面下側の「Confluence update check」リンクをクリックします。


ドロップダウンリストで、アップデート予定のバージョンを選択します。バージョンを選択できたら「チェック」ボタンをクリックします。

ご使用中のアドオンについて、互換性に問題のあるもの、問題のないものなどに分類されて表示されます。簡単な対応方法も表示されますので、参考にして対応を行なってください。基本的に、互換性のないアドオンの場合はいったん無効にしてからアップデートを行うことになります。使用予定のバージョンに対応したアドオンがあるかは、各アドオンの配布ページ、作者にご確認ください。

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

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

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

新規に Confluence をインストールしたときと同様に、Atlassianのサイト からインストール用ファイルをダウンロードします。
適当なディレクトリに保存してください。

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

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

  • server.xmlに記載されているポート番号(コンテキストルートは引き継がれません)
  • setenv.shに記載されている以下の環境変数
    • Xms …… ヒープ全体の初期値
    • Xmx …… ヒープ全体の最大値
    • XX:MaxPermSize ...... Permanent 領域の最大値

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

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

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

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

# ls -l
合計 1225720
-rw-r--r--. 1 root root 619636751  9月  6 17:10 atlassian-confluence-6.15.7-x64.bin
# chmod 744 atlassian-confluence-6.15.7-x64.bin
# ls -l
合計 1225720
-rwxr--r--. 1 root root 619636751  9月  6 17:10 atlassian-confluence-6.15.7-x64.bin

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

# ./atlassian-confluence-6.15.7-x64.bin
Unpacking JRE ...
Starting Installer ...

This will install Confluence 6.15.7 on your computer.
OK [o, Enter], Cancel [c]

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

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

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

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

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

Back Up Confluence Home
The upgrade process will automatically back up your Confluence Installation
Directory. You can also choose to back up your existing Confluence 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 Confluence installation.


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

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

Checking for local modifications.

List of modifications made within Confluence directories.

The following provides a list of file modifications within the confluence
directory.

Modified files:
            conf/server.xml
Removed files:
        (none)
Added files:
        (none)
Added files:
        confluence/WEB-INF/classes/log4j-diagnostic.properties

[Enter]

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

Checking if your instance of Confluence is running
Upgrade Check List
Back up your external database
We strongly recommend you back up your Confluence database if you have not
already done so.

Please refer to the following URL for back up guidelines:
http://docs.atlassian.com/confluence/docs-6.15.7/Production+Backup+Strategy

Check plugin compatibility
Check that your non-bundled plugins are compatible with Confluence 6.15.7.

Access the plugin manager through the following URL:
http://localhost:8090/plugins/servlet/upm#compatibility

For more information see our documentation at the following URL:
http://docs.atlassian.com/confluence/docs-6.15.7/Installing+and+Configuring+Plugins+using+the+Universal+Plugin+Manager


Please ensure you have read the above checklist before upgrading.
Your existing Confluence installation is about to be upgraded!

The upgrade process will shut down your existing Confluence installation to complete the upgrade.

Do you want to proceed?
Upgrade [u, Enter], Exit [e]

アップデートインストールが実行されます。
完了すると Confluence を起動するか聞かれます。

起動してもよければ y を選択し[Enter]キーを押します。

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

Backing up the Confluence home directory

Deleting the previous Confluence installation directory...

Extracting files ...


Please wait a few moments while we configure Confluence.
Installation of Confluence 6.15.7 is complete
Start Confluence now?
Yes [y], No [n, Enter]
y

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

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

ご注意ください

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

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

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

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

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