Confluence アップグレード用にステージング環境を作成する

Confluence をアップグレードする際は、本番サイトをアップグレードする前に、テスト環境でアップグレードを実施することを強くお勧めします。このガイドでは、テスト環境をステージングと読んでいます。 

ほとんどの Confluence ライセンスには、ステージング環境用に無料の開発ライセンスが含まれています。ライセンスにアクセスする方法については、「ステージング環境用ライセンスの取得方法」を参照してください。 

このページの内容

ステージング環境の作成

1. 環境の複製

ステージング環境は、リバース プロキシ、SSL 設定、またはロードバランサ(データセンターの場合)を含めて、実環境(本番)環境を厳密に複製する必要があります。異なる物理サーバーまたは仮想ソリューションを使用することもできます。重要なことは、本番環境の適切なレプリカとすることです。 

以下の説明では、ステージング環境が物理的に本番環境と分離されており、同じオペレーティングシステム を備えていることを前提としています (Confluence を手動でインストールした場合には、同一の Java バージョンであることも前提となります)。 

2. データベースの複製

データベースを複製する手順

  1. 本番環境データベースをバックアップします。バックアップの最良の方法の詳細については、データベースのドキュメントを参照してください。 
  2. ステージング サーバーにデータベースをインストールし、バックアップをリストアします。 

データベース バックアップのリストア手順は、選択したデータベースとバックアップ ツールによって異なります。以下を確認してください。

  • 新しいステージング データベースが本番環境データベースと異なる名前であること。
  • ステージング データベースのユーザーアカウントは、本番データベースのユーザーアカウントと同じユーザー名およびパスワードです。
  • 文字エンコードおよびその他の設定は本番データベースと同じです (たとえば、Oracle データベースの場合、文字エンコードは Unicode UTF-8 (または AL32UTF8 のはずです)。 

3 Confluence の複製

Confluence を複製するには、ご使用の Confluence インストールのコピーを作成し、ステージング データベースをポイントするようにします。以下の説明は、Confluence Server 向けです (Data Center の場合、Confluence を起動する前にいくつか追加手順があります)。 

  1. 本番環境のインストール ディレクトリ全体をステージング サーバーにコピーします。 
  2. 本番環境のホームディレクトリ全体をステージングサーバーにコピーします。 
  3. <installation-directory>/confluence/WEB-INF/classes/confluence-init.properties を編集し、ステージング ホーム ディレクトリを指定します。 
  4. <home-directory>/confluence.cfg.xmlまたは  <installation-directory>/server.xml を編集し、ステージング データベースを指すようにします。

    JDBC 直接接続を使用している場合、confluence.cfg.xml で更新する必要がある行は、次のようになります。
    <property name="hibernate.connection.url">jdbc:postgresql://localhost:5432/confluencestaging</property>
    データソース接続を使用している場合、server.xml で更新する必要がある行は、次のようになります。
    <Resource name="jdbc/confluence" auth="Container" type="javax.sql.DataSource"
         username="postgres"
         password="postgres"
         driverClassName="org.postgresql.Driver"
         url="jdbc:postgresql://localhost:5432/confluencestaging"
         maxTotal="60"
         maxIdle="20"
         validationQuery="select 1" />
  5. 以下のシステムプロパティで Confluence を起動し、ステージングサイトが実際のユーザーに通知を送信しないことを確認します。   

    -Datlassian.notifications.disabled=true
    -Datlassian.mail.senddisabled=true
  6. http://localhost:<port>  に進み、ステージング サーバーの Confluence にログインします。 
  7. > [一般設定] に進み、ステージングサイトのベース URL を変更します (例: mysite.staging.com)。
  8. > [一般設定] > [ライセンス詳細] に移動し、開発ライセンスを適用します。
  9.  > [一般設定] > [システム情報] に進み、Confluence がステージング データベース、およびステージング ホーム ディレクトリを正しくポイントしていることを確認します。

    本番環境データベースにまだ接続されていないことを確認するのは必須です。

データセンター用の追加手順

Confluence Data Center を持っている場合、このプロセスは上述した Confluence Server とほぼ同じです。各ローカルのホームディレクトリとインストールディレクトリを各ステージングノードにコピーして、次の操作を実行します。   

  1. 本番環境の共有ホーム ディレクトリをステージング サーバーにコピーします。 
  2. <local-home-directory>/confluence.cfg.xml を編集し、ステージングの共有ホーム ディレクトリを指定します。この変更は、すべてのステージング ノードで実施する必要があります。 

<installation-directory>/confluence/WEB-INF/classes/confluence-init.properties および <home-directory>/confluence.cfg.xml に対する変更は、すべてのステージング ノードで実施する必要があります。

Confluence を起動するときは、通常どおり、一度に1つのノードを起動してください。 

4 外部ユーザー管理の複製 (オプション)

Jira、Crowd、または外部 LDAP ディレクトリでユーザーを管理している場合、以下が可能です。

  • ステージング環境の Jira、Crowd、または外部ディレクトリを複製し、Confluence ステージング サイトがステージング外部ディレクトリを使用するように指定しすることができます(推奨)。
  • ステージング用サーバーをネットワークに接続するか、本番用サーバーと同じホストにローカルからアクセスします。 

その他の構成オプション

ステージング環境では、本番環境に影響しないようにしたり、ユーザーのために本番環境と明確に区別できるようにしたりするために、多数の変更を行います。 

シングル サインオンを回避する

シングル サインオンを設定している場合は、ステージング環境でこれを回避します。 

Confluence Data Center で規定のログイン ページを有効にして SAML を回避する」をご参照ください。 

CDN を無効にする

静的アセットをキャッシュするように CDN を設定した場合、CDN 設定はステージング環境用ではなく本番環境用であるため、リソースが壊れるという問題が発生する可能性があります。 

CDN を無効にする方法については、「Confluence Data Center 用に CDN を設定する」をご参照ください。

アプリケーション リンクの変更 (推奨)

Confluence と他のアトラシアン アプリケーションとの間にアプリケーション リンクが存在する場合、各ステージング アプリケーションでサーバー ID を変更する必要があります。「Confluence のサーバー ID を変更する方法および、Jira についてはJira サーバーのインスタンスのサーバー ID を変更する」を参照してください。

サーバー ID を変更せず、アプリケーション リンクを更新する場合、本番環境で新しいアプリケーション リンクを作成すると、代わりにステージング サーバーを指すことになります。

データベースでアプリケーション リンクのレビューを手動で行うには、次の SQL クエリを使用します。

select * from bandana where bandanakey like 'applinks%';

外部ガジェットの変更 

外部ガジェットを構成している場合は、次の SQL クエリを使用してデータベースから更新できます。

select * from bandana where bandanakey = 'confluence.ExternalGadgetSpecStore.specs'

グローバル カラー スキームの変更

本番サイトと区別できるよう、ステージング サイトでは別のカラー スキームを使用することをおすすめします。この方法については、「カラー スキームのカスタマイズ」を参照してください。 

次の SQL クエリを使用してデータベースでこのデータを見つけることもます。

select * from bandana where bandanakey = 'atlassian.confluence.colour.scheme';


インスタンス名の変更 (推奨)

本番環境サイトと区別できるよう、ステージング サイトの名前を変更することをおすすめします。Confluece を実行中の場合は  > [一般設定] へ移動し、[サイト タイトル] を更新します。 

Confluence が実行されていない場合、これをデータベースから実行できます。次の SQL クエリを使用してサイト タイトルを見つけることができます。

select * from bandana where bandanakey = 'atlassian.confluence.settings';

setTitle. 属性を探します。

バナーの追加

ステージング サイトにバナーを追加すると、最終更新日や、変更を加えたい場合の連絡先などの便利な情報を提供できます。 

Confluence Data Center ライセンスをお持ちの場合は、読み取り専用モードで提供されるするバナーを有効化してこれを実現できます (バナーは読み取り専用モードを有効化しなくても使用できます)。 

Confluence Server ライセンスをお持ちの場合は、HTML を使用して手動でバナーを追加できます。 > [一般設定] > [カスタム HTML] を開きます。タグが適切に閉じられていることを確認します。不適切なタグがある場合、Confluence は正常に表示されない場合があります。 

Confluence の起動前にバナーを追加したい場合、データベースで実行することができます。次の SQL クエリを使用してカスタム HTML を見つけることができます。

select * from bandana where bandanakey = 'atlassian.confluence.settings';

customHtmlSettings → afterBodyStart 属性を見つけます。

特定のプラグインの無効化 

特定のプラグインを無効化したり、これらのプラグインが既に無効化されているかどうかを確認する必要がある場合があります。この方法については、ナレッジベース記事「データベースからすべての Confluence プラグインを既定の状態にリセットする方法」を参照してください。 

Confluence 6.1 以降で Java システム プロパティを使用して Confluence でプラグインを無効化することもできます。  

ステージング環境のアップグレード

ステージング環境を作成したら、本番環境を同じ方法で更新することができます。 

アップグレードの所要時間をメモします。この情報は、本番システムの停止を計画したり、ユーザーと連絡を取ったりする際に役立ちます。 

ステージング環境を使用して、カスタマイズやサイトに必須の Marketplace アプリをテストすることもできます。 

最終更新日: 2022 年 1 月 25 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.