1. バックアップ/リストア

作成したドメインの環境をバックアップ、リストアする手順について説明します。

1.1. ドメイン環境の自動バックアップ

WebOTXでは、ファイル書き込み中の電源障害による設定ファイルの破損や、設定変更のミスによりドメインが正常に起動できなくなった場合に備え、前回正常起動した時の状態を自動でバックアップしています。バックアップからファイルを復元することで前回正常起動した状態まで環境を元に戻すことができます。

1.1.1. 自動バックアップの注意事項

1.1.2. 自動バックアップの設定変更

ドメイン環境の自動バックアップでは、各ドメイン毎の${INSTANCE_ROOT}配下のファイルを以下のディレクトリに自動でバックアップしています。(デフォルトでは、前回3回分の正常起動時のファイルがfiles1〜files3のディレクトリ名で保存されています。)

${INSTANCE_ROOT}/backup/files1〜files3

バックアップ世代数の変更を変更する場合は、以下の手順を行ってください。世代数は0から3の間で設定できます。以下の例は世代数を1に変更する場合です。1の部分を設定する世代数にあわせて変更してください。

otxadmin> set domain.num-config-backup-generations=1

ドメイン環境の自動バックアップされるディレクトリを指定することができます。domain.backup-optionに値を設定することで、バックアップ対象を指定することができます。設定できる値はall、またはconfigsとなります。(デフォルトでは configs が指定されています。)

以下のように設定を行います。

otxadmin > set domain.backup-option=all

または、

otxadmin > set domain.backup-option=configs

バックアップされるディレクトリの一覧は以下のようになります。

表1.1.2-1
バックアップされるディレクトリ domain.backup-option=allの場合 domain.backup-option=configsの場合
applications ×
autodeploy ×
backup × ×
bin ×
config
diagnostic-reports × ×
docroot ×
generated ×
java-web-start ×
jbi(Enterprise Service Busを利用の場合)
lib ×
logs × ×
session-store ×
stats ×
wojms ×

1.1.3. 自動バックアップからの復元

以下では、前回正常起動時の状態にドメイン環境を戻す方法について説明します。

(作業の前には、次章のバックアップ手順を参照してバックアップをとってください。)

  1. ドメインを停止します。
    otxadmin> stop-domain WebOTXAdmin
    
  2. 前回正常起動時のドメイン環境に復元します。

    この操作により、上記で指定したドメインの環境(=${INSTANCE_ROOT}配下)が前回正常起動時の状態に復元されます。復元前の(ドメインの起動に失敗した環境の)各種ファイルは、デフォルトでは${INSTANCE_ROOT}配下に作成される一時保管領域であるfailedディレクトリ内に移動されます。

    なお、クラスタ環境構築などにより、ドメイン環境が<WebOTXインストールディレクトリ>\domains配下に存在しない場合や、ディスク容量不足などの理由で、バックアップ領域や一時保管領域を別のディスク領域に変更する場合は、以下のように指定してください。

    例:
    <WebOTXインストールディレクトリ>\bin\otxrecovery.bat D:\domains\domain1 D:\domains\domain1\backup D:\domains\domain1\failed
    

1.1.4. 復元時の注意事項

1.2. 環境の退避

環境の退避は、障害発生時に障害発生前の状態に復元するためや、環境の移行の際の移行前の環境を保存するためなどに利用します。

以下は、各々のOSについての環境の退避する必要のあるファイルの一覧です。

環境の退避はWebOTXを停止した状態で行ってください。

1.2.1. Windows

1.2.2. UNIX

1.3. 同一環境にリストアする手順

バックアップした環境からWebOTXの環境をリストア(復元)します。

ただし、同一環境にリストアする場合でも、ドメインの構成に変更がある環境やアンインストール後のリストアの場合は、「異なる環境にリストアする手順」で示した手順を用いてOSのサービス登録情報などを復元する必要があります。

1.3.1. Windows

バックアップした次のファイルを元の場所にコピーしてください。

リストア前と後でWebOTXのバージョンアップを実施している場合には、復元した環境における次のディレクトリを削除してください。

この作業は、管理ドメイン(WebOTXAdmin)を除くすべてのドメインに対して実施します。

1.3.2. UNIX

バックアップした次のファイルを元の場所にコピーしてください。

リストア前にWebOTXのバージョンアップを実施している場合には、復元した環境における次のディレクトリを削除してください。

この作業は、管理ドメイン(WebOTXAdmin)を除くすべてのドメインに対して実施します。

1.4. 異なる環境にリストアする手順

WebOTXの環境を別のマシンに移行する場合の手順は以下のとおりです。ただし、移行前のマシンと移行後のマシンで別々のWebOTXのライセンスを利用する場合は、移行前のマシンのWebOTXを削除する必要はありません。

  1. 移行前のマシンの環境の退避

    環境の退避を参照してください。

  2. 移行前のマシンの環境の削除

    移行前のマシンのWebOTXをアンインストールしてください。UNIX版の場合は、設定したライセンスも削除してください。

  3. 移行後のマシンへのWebOTXのインストール

    移行するマシンにWebOTXをインストールしてください。

  4. 設定ファイルの復元

    移行前にバックアップした以下の設定ファイルを移行後のマシンに復元します。(domains配下のファイルについては、ここではリストアしないでください。)


  5. 移行後の環境設定

    移行後のマシンのWebOTXインストールディレクトリが異なる場合は以下のファイルを修正します。

  6. ドメインの作成

    ドメインを作成します。ドメインを作成することでOSのサービス登録情報などを復元します。

    WebOTXインストールディレクトリ配下に先ほど復元した、ドメイン設定ファイル(xxx.properties)ファイルを使ってドメインを作成します。以下のコマンドを実行してください。ドメインが複数ある場合はすべてのドメインについてcreate-domainコマンドを実行します。また、インストール時にデフォルトで作成されるdomain1 を利用しない場合は delete-domainコマンドにて削除します。

    .\bin\otxadmin start-domain WebOTXAdmin
    .\bin\otxadmin stop-domain domain1 (※domain1を利用しない場合)
    .\bin\asant -buildfile setup.xml -Ddomain.name=domain1 delete-domain (※domain1を利用しない場合)
    .\bin\asant -buildfile setup.xml -Dfile=xxx.properties create-domain
    …
    .\bin\otxadmin stop-domain WebOTXAdmin
    
  7. ドメイン環境を復元

    移行前にバックアップしたdomains配下のファイルを移行後のマシンに上書きして復元します。

  8. 不要なディレクトリの削除

    復元したdomains配下に次のディレクトリがある場合は削除します。

    この作業は、管理ドメイン(WebOTXAdmin)を除くすべてのドメインに対して実施します。

  9. 固有情報の再設定

    WebOTXが停止した状態で、以下のコマンドを実行してください。
    ドメインの設定ファイル内に保存されたサーバ固有の情報(ホスト名など)を、現在のサーバの情報に置換します。

  10. ホスト情報の変更をWebOTXの内部サービスに反映させるためのプロパティファイルを作成

    次のファイルを作成してください。

    ファイルに記載する内容のうち、移行前の環境のホスト名は、移行前にバックアップしたファイルの次のファイルに記載されている値を指定してください。

  11. WebOTXを起動

    WebOTXを起動してください。

1.5. ドメイン構成ファイル(domain.xmlとdomains-config.xml)の自動復旧機能

WebOTXでは、これまでに紹介したバックアップ機能を更に強化し、特にドメインの起動を妨げるような状況に陥るのをできるだけ回避するよう、ドメインの構成情報を格納する2つの重要なファイル(domain.xml、およびdomains-config.xml)については、更新時にリアルタイムにバックアップを取るようにしています。そして、ファイル破損等の万一の障害の際には自動でバックアップファイルから復旧するよう強化しています。これにより、障害の影響でドメインが正常に起動しなくなるという問題が大幅に解決されます。

自動復旧機能の対象となるファイルは以下の場所に格納されています。

${INSTANCE_ROOT}/config/domain.xml

${INSTANCE_ROOT}/config/domains-config.xml (管理ドメインのみ)

これらのファイルに対して本機能が正常に実行された場合は、webotx_agent.log に以下のようなメッセージが出力されます。

(例) ドメイン構成ファイル domain.xml が不正なため読み込みに失敗しましたが、バックアップファイルによってリカバリされ、正常に読み込まれました。

なお、これらのバックアップファイルは同じディレクトリ内に“.backup”という拡張子で必要時に作成されますので、以下の事項にご注意願います。

1.5.1. 注意事項