作成したドメインの環境をバックアップ、リストアする手順について説明します。
WebOTXでは、ファイル書き込み中の電源障害による設定ファイルの破損や、設定変更のミスによりドメインが正常に起動できなくなった場合に備え、前回正常起動した時の状態を自動でバックアップしています。バックアップからファイルを復元することで前回正常起動した状態まで環境を元に戻すことができます。
ドメイン環境の自動バックアップでは、各ドメイン毎の${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
バックアップされるディレクトリの一覧は次のとおりです。
| バックアップされるディレクトリ | 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 | × | × |
| osgi-cache | × | × |
| session-store | ○ | × |
| stats | ○ | × |
| wojms | ○ | × |
また、ドメイン環境の自動バックアップされるタイミングを指定することができます。domain.backup-timingに値を設定します。設定できる値はbefore-starting、after-runningまたはbefore-terminationです。(デフォルトでは before-starting が設定されています。)
次のように設定します。
otxadmin > set domain.backup-timing=before-starting
バックアップされるタイミングの詳細は次のとおりです。
| 設定値 | バックアップのタイミング |
|---|---|
| before-starting | ドメインが起動処理を開始し、エージェントプロセスが立ち上がる直前 |
| after-running | ドメインが起動処理を完了した直後 |
| before-termination | ドメインが停止処理を完了し、エージェントプロセスが終了する直前 |
以下では、前回正常起動時の状態にドメイン環境を戻す方法について説明します。
（作業の前には、次章のバックアップ手順を参照してバックアップをとってください。）
otxadmin> stop-domain WebOTXAdmin
<WebOTXインストールディレクトリ>\bin\otxrecovery.bat <ドメイン名>
/opt/WebOTX/bin/otxrecovery <ドメイン名>
この時、復元するバックアップの世代対象を、--fileオプションで指定することができます。 1〜3の範囲で値を指定することで、1〜3世代前のバックアップ環境から選択して復元することが可能になります。
たとえば、1世代前のバックアップ環境から復元したが、何らかの理由で正常にドメインが起動できなかった場合、次のように2世代前のバックアップ環境を用いて復元を試みることができます。
<WebOTXインストールディレクトリ>\bin\otxrecovery.bat --file 2 <ドメイン名>
/opt/WebOTX/bin/otxrecovery --file 2 <ドメイン名>
この操作により、上記で指定したドメインの環境(=${INSTANCE_ROOT}配下)が前回正常起動時の状態に復元されます。復元前の（ドメインの起動に失敗した環境の）各種ファイルは、デフォルトでは${INSTANCE_ROOT}配下に作成される一時保管領域であるfailedディレクトリ内に移動されます。
なお、クラスタ環境構築などにより、ドメイン環境が<WebOTXインストールディレクトリ>\domains配下に存在しない場合や、ディスク容量不足などの理由で、バックアップ領域や一時保管領域を別のディスク領域に変更する場合は、以下のように指定してください。
<WebOTXインストールディレクトリ>\bin\otxrecovery.bat <${INSTANCE_ROOT}の値> <バックアップ格納場所> <一時保管場所>
/opt/WebOTX/bin/otxrecovery <${INSTANCE_ROOT}の値> <バックアップ格納場所> <一時保管場所>
<WebOTXインストールディレクトリ>\bin\otxrecovery.bat D:\domains\domain1 D:\domains\domain1\backup D:\domains\domain1\failed
cd ${INSTANCE_ROOT}
del /S /Q .\applications\j2ee-apps\*
del /S /Q .\applications\*
del /S /Q .\autodeploy\*
cd ${INSTANCE_ROOT}
rm -Rf ./applications/j2ee-apps/*
rm -Rf ./applications/*
rm -Rf ./autodeploy/*
cd ${INSTANCE_ROOT}
xcopy /S /E /Y .\backup\files1\* .\
cd ${INSTANCE_ROOT}
cp -pR ./backup/files1/* ./
環境の退避は、障害発生時に障害発生前の状態に復元するためや、環境の移行の際の移行前の環境を保存するためなどに利用します。
以下は、各々のOSについての環境の退避する必要のあるファイルの一覧です。
環境の退避はWebOTXを停止した状態で行ってください。
バックアップした環境からWebOTXの環境をリストア（復元）します。
ただし、同一環境にリストアする場合でも、ドメインの構成に変更がある環境やアンインストール後のリストアの場合は、「異なる環境にリストアする手順」で示した手順を用いてOSのサービス登録情報などを復元する必要があります。
バックアップした次のファイルを元の場所にコピーしてください。
復元した環境における次のディレクトリを削除してください。
この作業は、管理ドメイン(WebOTXAdmin)を除くすべてのドメインに対して実施します。
バックアップした次のファイルを元の場所にコピーしてください。
復元した環境における次のディレクトリを削除してください。
この作業は、管理ドメイン(WebOTXAdmin)を除くすべてのドメインに対して実施します。
WebOTXの環境を別のマシンに移行する場合の手順は以下のとおりです。ただし、移行前のマシンと移行後のマシンで別々のWebOTXのライセンスを利用する場合は、移行前のマシンのWebOTXを削除する必要はありません。
環境の退避を参照してください。
移行前のマシンのWebOTXをアンインストールしてください。UNIX版の場合は、設定したライセンスも削除してください。
移行するマシンにWebOTXをインストールしてください。
移行前にバックアップした以下の設定ファイルを移行後のマシンに復元します。(domains配下のファイルについては、ここではリストアしないでください。)
移行後のマシンのWebOTXインストールディレクトリが異なる場合は以下のファイルを修正します。
<WebOTXインストールディレクトリ>\config\asenv.batに記述されている各ディレクトリ設定を移行後の設定に合わせ修正します。
set AS_ANT=C:\WebOTX\lib\ant set AS_ANT_LIB=C:\WebOTX\lib\ant\lib set AS_WEBSERVICES_LIB=C:\WebOTX\lib set AS_IMQ_LIB=C:\WebOTX\wojms\lib set AS_IMQ_BIN=C:\WebOTX\wojms\bin set AS_CONFIG=C:\WebOTX\config set AS_INSTALL=C:\WebOTX set AS_JAVA=C:\jdk1.7.0_51 set AS_ACC_CONFIG=C:\WebOTX\lib\appclient\nec-acc.xml set AS_ICU_LIB=C:\WebOTX\lib set AS_DEF_DOMAINS_PATH=C:\WebOTX\domains set AS_OSPI_LIB=C:\WebOTX\ObjectBroker\lib set AS_BOOT_DOMAIN=WebOTXAdmin
/opt/WebOTX/config/asenv.confに記述されている各ディレクトリ設定を移行後の設定に合わせ修正します。
AS_ANT="/opt/WebOTX/lib/ant" AS_ANT_LIB="/opt/WebOTX/lib/ant/lib" AS_WEBSERVICES_LIB="/opt/WebOTX/lib" AS_IMQ_LIB="/opt/WebOTX/wojms/lib" AS_IMQ_BIN="/opt/WebOTX/wojms/bin" AS_CONFIG="/opt/WebOTX/config" AS_INSTALL="/opt/WebOTX" AS_JAVA="/usr/java/jdk1.7.0_51" AS_ACC_CONFIG="/opt/WebOTX/lib/appclient/nec-acc.xml" AS_ICU_LIB="/opt/WebOTX/lib" AS_DEF_DOMAINS_PATH="/opt/WebOTX/domains" AS_OSPI_LIB="/opt/ObjectSpinner/lib" AS_BOOT_DOMAIN="WebOTXAdmin"
ドメインを作成します。ドメインを作成することでOSのサービス登録情報などを復元します。
管理ドメインの起動/停止については[ドメイン構築・基本設定ガイド > 3.4. ドメインの起動・停止 > 3.4.2. 管理ドメインの起動/停止 ] を確認してください。
既定でドメイン(domain1)が作成されており、不要な場合、以下のコマンドを使用しドメインの削除を行ってください。
otxadmin > login --user <管理ドメインのユーザ名> --password <管理ドメインのパスワード> --port <管理ドメインのポート番号> otxadmin > delete-domain domain1
先ほど復元した、ドメイン設定ファイル(<ドメイン名>.properties)を使ってドメインを作成します。以下のコマンドを実行してください。ドメインが複数ある場合はすべてのドメインについてcreate-domainコマンドを実行します。
otxadmin > login --user <管理ドメインのユーザ名> --password <管理ドメインのパスワード> --port <管理ドメインのポート番号> otxadmin > create-domain --file=<ドメイン名>.properties <ドメイン名>
管理ドメインの起動/停止については[ドメイン構築・基本設定ガイド > 3.4. ドメインの起動・停止 > 3.4.2. 管理ドメインの起動/停止 ] を確認してください。
移行前にバックアップしたdomains配下のファイルを移行後のマシンに上書きして復元します。
<WebOTXインストールディレクトリ>\domains
/opt/WebOTX/domains
復元したdomains配下に次のディレクトリがある場合は削除します。
<WebOTXインストールディレクトリ>\domains\<ドメイン名>\generated\jsp\manager
/opt/WebOTX/domains/<ドメイン名>/generated/jsp/manager
この作業は、管理ドメイン(WebOTXAdmin)を除くすべてのドメインに対して実施します。
WebOTXが停止した状態で、以下のコマンドを実行してください。
ドメインの設定ファイル内に保存されたサーバ固有の情報(ホスト名など)を、現在のサーバの情報に置換します。
<WebOTXインストールディレクトリ>\bin\configreplace.bat <ドメイン名>
/opt/WebOTX/bin/configreplace <ドメイン名>
次のファイルを作成してください。
<WebOTXインストールディレクトリ>\domains\<ドメイン名>\config\reconfig
/opt/WebOTX/domains/<ドメイン名>/config/reconfig
hostname.old=<移行前の環境のホスト名> hostname.new=<移行後の環境のホスト名>
ファイルに記載する内容のうち、移行前の環境のホスト名は、移行前にバックアップしたファイルの次のファイルに記載されている値を指定してください。
<WebOTXインストールディレクトリ>\domains\<ドメイン名>\config\domain.xml
/opt/WebOTX/domains/<ドメイン名>/config/domain.xml
<?xml version="1.0" encoding="UTF-8"?> ・・・・ <domain application-root=・・・ hostname="<移行前の環境のホスト名>" ・・・>
WebOTXを起動してください。
WebOTXでは、これまでに紹介したバックアップ機能を更に強化し、特にドメインの起動を妨げるような状況に陥るのをできるだけ回避するよう、ドメインの構成情報を格納する2つの重要なファイル(domain.xml、およびdomains-config.xml)については、更新時にリアルタイムにバックアップを取るようにしています。そして、ファイル破損等の万一の障害の際には自動でバックアップファイルから復旧するよう強化しています。これにより、障害の影響でドメインが正常に起動しなくなるという問題が大幅に解決されます。
自動復旧機能の対象となるファイルは以下の場所に格納されています。
${INSTANCE_ROOT}/config/domain.xml
${INSTANCE_ROOT}/config/domains-config.xml (管理ドメインのみ)
これらのファイルに対して本機能が正常に実行された場合は、webotx_agent.log に以下のようなメッセージが出力されます。
(例) ドメイン構成ファイル domain.xml が不正なため読み込みに失敗しましたが、バックアップファイルによってリカバリされ、正常に読み込まれました。
なお、これらのバックアップファイルは同じディレクトリ内に“.backup”という拡張子で必要時に作成されますので、以下の事項にご注意願います。