> ユーザー・ガイド > WDTツール > Update Domain Tool

Update Domain Tool

Update Domain Toolは、モデル、アーカイブおよびWLSTを使用して既存のWebLogic Serverドメインの構成を更新し、WLSTオンライン・モードまたはオフライン・モードでアプリケーションおよびリソースをドメインにデプロイします。 Update Domain Toolは、モデルのtopologyセクションから要素を追加または再構成し、resourcesおよびappDeploymentsセクションからアプリケーションおよびリソースをデプロイします。

Discover Domain Toolと同様に、Update Domain Toolはオフライン・モードまたはオンライン・モードで実行でき、オンライン・モードにはその動作を制御するオプションがあります。

オフライン・モード - オフライン・モードでは、WLSTオフラインを使用して、ドメイン・ホーム・ディレクトリからドメイン構成を読み取って更新します。つまり、このツールはドメインの管理サーバーと同じホスト上で実行する必要があり、このツールを実行するユーザーはドメイン・ホーム・ディレクトリ構造への完全な読取りおよび書込みアクセス権を必要とします。
オンライン・モード - オンライン・モードでは、WLSTをオンラインで使用して、管理サーバーのMBeansを使用してドメイン構成を読み取って更新します。ツールを実行しているユーザーは、管理サーバーに接続するための管理資格証明およびURLを指定する必要があります。ツールの実行時には、次の3つのオプションがあります:
- 標準モード(デフォルト) - このモードでは、ツールはドメインの管理サーバーと同じホスト上で実行する必要があり、ツールを実行しているユーザーは、ドメインのホーム・ディレクトリ構造に対する完全な読取りおよび書込みアクセス権、およびドメイン固有のファイルが格納されている他のロケーションへの完全な読取りアクセス権を持っている必要があります。
- -remoteモード - このモードでは、ドメインの管理サーバーが配置されているホスト以外のホストからツールを実行できます。管理サーバーが実行されているホストのファイル・システムに直接アクセスできないため、次の制限があります:
  - パスがwlsdeploy/applicationsまたはwlsdeploy/sharedLibrariesで始まる場合を除き、アーカイブ・ファイルへのパスを参照したモデルの属性はすべてエラーになります。ツールはそのようなディレクトリまたはファイルをリモートで作成できないためです。たとえば、アーカイブ・ファイルwlsdeploy/domainBin/setUserOverrides.sh内のファイル・エントリを参照するdomainBin: [ wlsdeploy/domainBin/setUserOverrides.sh ]を指定すると、ツールがエラーで失敗します。
  - アーカイブ内の展開された形式のアプリケーションおよび共有ライブラリはサポートされていません。これは、ディレクトリではなくファイルのアップロードのみをサポートするWebLogicデプロイ・サブシステムに制限があるためです。
- SSHモード - このモードでは、このツールは、WDTが実行されているホストと管理サーバーが稼働しているホストとの間のSSH接続を設定している任意のホストから実行できます。 -ssh_user (デフォルトでは、このツールを実行しているユーザーと同じユーザー)には、ドメインのホーム・ディレクトリ構造に対する完全な読取りおよび書込みアクセス権と、ドメイン固有のファイルが格納されている他のロケーションへの完全な読取りアクセス権が必要です。 SSHモードでの実行の詳細は、「SSHのサポート」およびVerify SSH Toolのページを参照してください。

Update Domain Toolは、指定されたモデル内の要素のみを追加または更新します。ドメインに既に存在しないエレメントは削除されません。 Update Domain Toolは、RCUを使用するドメイン・タイプのRCUデータベースのスキーマの再作成または追加を試行しません。

WLSTオンライン・モードでは、ツールによって、アプリケーションおよび共有ライブラリの再デプロイおよびサーバーを再起動する必要性が最小限に抑えられます。これはいくつかの点で行われます:

モデルが、すでにデプロイされているアプリケーションまたは共有ライブラリを参照している場合、ツールはバイナリを比較して再デプロイメントが必要かどうかを判断します。共有ライブラリを使用するすべてのアプリケーションは、アプリケーションが変更されていない場合でも再デプロイする必要があるため、共有ライブラリの再デプロイは特にコストがかかります。
ナレッジ・ベースを参照して、変更時に再起動する必要がある属性を決定します。属性の再起動が必要な場合、ツールは現在のドメイン値とモデル値を比較して、変更を適用する前にそれらが異なることを確認します。

目標は、ツールが反復的なデプロイメントをサポートできるようにし、実行中のドメインに対して作業中にサービスの中断を最小限に抑えることができることです。

共有ライブラリのオンライン更新

共有ライブラリをオンラインで更新する場合は、MANIFEST.MFファイルのバージョンを更新し、新しいライブラリを使用するようにアップグレードするアプリケーションのデプロイメント記述子を更新することによって、新しいバージョンのライブラリをデプロイすることをお勧めします。これにより、共有ライブラリのインプレース更新などの複雑な問題が回避されます。

共有ライブラリのオンラインのインプレース更新はサポートされていません。 MANIFEST.MFファイルのライブラリのバージョンを更新せずに、ライブラリの内容のみを更新する場合。 WebLogic Serverから、ライブラリがアプリケーションによって参照されており、アンデプロイできないことを示すエラーが表示されます。先に進む前に、共有ライブラリを参照しているすべてのアプリケーションをアンデプロイする必要があります。これは、WebLogic Serverコンソールを使用する際の動作と同じです。また、共有ライブラリは、別の共有ライブラリ・モジュールによって参照される可能性があり、そのライブラリがインプレースで更新されるときに共有ライブラリを使用するアプリケーションのアンデプロイおよびデプロイを自動化する機能を現在、WebLogic Server内で処理することはできません。

出力ファイルの使用

-output_dirコマンド行引数が指定されている場合、ツールは、再起動が必要なサーバーおよびリソースに関する情報を提供する出力ファイルを生成します。これらのファイルは、オンライン・デプロイメントにのみ適用できます。

ファイルrestart.fileには、再起動する必要があるサーバーおよびリソースのリストが含まれます。例:

:AdminServer:Generic1:JDBCSystemResource
:AdminServer::

ファイルnon_dynamic_changes.fileには、新しい値を適用するために再起動が必要な属性を説明するテキストが含まれています。例:

Server re-start is REQUIRED for the set of changes in progress.

The following non-dynamic attribute(s) have been changed on MBeans 
that require server re-start:
MBean Changed : com.bea:Name=AdminServer,Type=Log,Server=AdminServer
Attributes changed : RedirectStderrToServerLogEnabled, RedirectStdoutToServerLogEnabled

MBean Changed : com.bea:Name=MailSession-0,Type=MailSession
Attributes changed : SessionPasswordEncrypted

ファイルresults.jsonには、サーバーおよびリソースの再起動が必要な情報と、新しい値を適用するために再起動が必要な属性値が含まれています。

{
    "nonDynamicChanges" : {
        "com.bea:Name=MailSession-0,Type=MailSession" : [
            "SessionPasswordEncrypted"
        ],
        "com.bea:Name=AdminServer,Type=Log,Server=AdminServer" : [
            "RedirectStderrToServerLogEnabled",
            "RedirectStdoutToServerLogEnabled"
        ]
    },
    "nonDynamicChangesText" : [
        "",
        "Server re-start is REQUIRED for the set of changes in progress.",
        "",
        "The following non-dynamic attribute(s) have been changed on MBeans",
        "that require server re-start:",
        "MBean Changed : com.bea:Name=AdminServer,Type=Log,Server=AdminServer",
        "Attributes changed : RedirectStderrToServerLogEnabled, RedirectStdoutToServerLogEnabled",
        "",
        "MBean Changed : com.bea:Name=MailSession-0,Type=MailSession",
        "Attributes changed : SessionPasswordEncrypted",
        ""
    ],
    "restarts" : [
        {
            "server" : "AdminServer",
            "resourceName" : "Generic1",
            "resourceType" : "JDBCSystemResource"
        },
        {
            "server" : "AdminServer"
        }
    ]
}

オフライン・モードでのツールの実行

WLSTオフライン・モードでのUpdate Domain Toolの実行は、Create Domain Toolの実行と非常に似ています。ドメインのロケーションとアーカイブ・ファイルを指定するだけで、必要に応じてモデルと変数ファイルが分離されます。例えば:

$ weblogic-deploy\bin\updateDomain.cmd -oracle_home c:\wls12213 -domain_home domains\DemoDomain -model_file DemoDomain.yaml -variable_file DemoDomain.properties -archive_file DemoDomain.zip

Create Domain Toolとは異なり、ドメインはすでに確立されているため、ドメインの親ディレクトリではなく、完全なドメイン・ホーム・ディレクトリが指定されます。

オンライン・モードでのツールの実行

WLSTオンライン・モードでは、-domain_home引数を削除して、WebLogic Server管理サーバーへの接続方法に関する情報を追加します。管理サーバーからオンラインWLSTモードで実行する例を次に示します:

$ weblogic-deploy\bin\updateDomain.cmd -admin_url t3://127.0.0.1:7001 -admin_user weblogic -oracle_home c:\wls12213â -model_file DemoDomain.yaml -variable_file DemoDomain.properties -archive_file DemoDomain.zip

-remoteモードでツールを実行する例を次に示します:

$ weblogic-deploy\bin\updateDomain.cmd -remote -admin_url t3://my.remote.machine:7001 -admin_user weblogic -oracle_home c:\wls12213 -model_file DemoDomain.yaml -variable_file DemoDomain.properties -archive_file DemoDomain.zip

SSHモードで実行すると、非常に似ています。この例では、WDTが実行されているホストから、ドメインの管理サーバーが実行されているホストへのSSH接続をすでに設定および検証済であることを前提としています。また、その他のSSH関連の引数のデフォルト値が構成に十分であると想定しています。

$ weblogic-deploy\bin\updateDomain.cmd -ssh_host my.remote.machine -admin_url t3://my.remote.machine:7001 -admin_user weblogic -oracle_home c:\wls12213 -model_file DemoDomain.yaml -variable_file DemoDomain.properties -archive_file DemoDomain.zip

通常どおり、ツールはパスワードの入力を求めます(ツールの標準入力にパイプして入力することもできます)。プロンプトをバイパスするには、次の2つのオプションのいずれかを使用できます:

パスワードを環境変数に格納し、コマンド行オプション-admin_pass_envで変数名を使用します。
パスワードをファイルに格納します。コマンドライン・オプション-admin_pass_fileを使用してファイル名を指定します。

WLSTオンライン・モードでツールを実行する場合、更新操作でサーバーの再起動や、変更を取得するためにドメインの再起動が必要になることがあります。更新操作では、ドメインが再起動されるまで操作を完了できない状況が発生することがあります。 Update Domain Toolを呼び出している可能性のあるスクリプトにこれらの条件を通信するには、シェル・スクリプトに2つの特殊なゼロ以外の終了コードがあり、これらの状態を通信します:

103 - ドメイン全体を再起動する必要があります。
104 - モデルの変更にはドメインの再起動が必要であり、-cancel_changes_if_restart_requiredが指定されているため、ドメインの変更は取り消されました。

暗号化モデルの使用

モデルまたは変数ファイルにWDT Encrypt Model Toolで暗号化されたパスワードが含まれている場合は、Create Domain Toolで復号化できるように、モデルの暗号化に使用するWDT暗号化パスフレーズを指定する必要があります。これを行うには、次のいずれかのコマンドライン引数を指定します:

-passphrase_env <ENV_VAR> - 指定された環境変数からパスフレーズを読み取ります。
-passphrase_file <file-name> - パスフレーズを含むファイルからパスフレーズを読み取る、または
-passphrase_prompt - シェル・スクリプトの標準入力に値をプロンプトまたはパイプして、stdinからパスフレーズを読み取ります。

複数のモデルの使用

「複数のモデルの使用」に説明されているように、Update Domain Toolでは複数のモデルを使用できます。

環境変数

次の環境変数を設定できます。

JAVA_HOME JDKのロケーション。これは有効なJava 7以降のJDKである必要があります。
WLSDEPLOY_PROPERTIES WLSTに渡されるシステム・プロパティ。

Update Domain Tool (およびWLSTを使用するその他のツール)を実行する場合、ツールの実行に使用される実際のJDKは、JAVA_HOME環境変数によって定義されたものではなく、Oracle HomeにWebLogic Serverをインストールするために使用されるJDKになります。ベスト・プラクティスは、WebLogic Serverのインストールに使用したものと同じJDKインストールを指すようにJAVA_HOMEを設定することです。