A カスタム・プロセスの構成

この章では、OPMN opmn.xmlファイルのカスタム・プロセス構成について説明します。

次のトピックで構成されています。

カスタム・プロセス・モジュールの構成
カスタム・プロセスの最小構成
カスタム・プロセスの完全構成
カスタム・プロセスの属性の説明

A.1 カスタム・プロセス・モジュールの構成

次の行は、カスタム・プロセス・モジュールのロードと識別を行います。プロセス・モジュールによるカスタム・プロセスの管理は、module idによって識別されます。

<module path="ORACLE_HOME/opmn/lib/libopmncustom.so">
   <module-id id="CUSTOM" />
</module>

A.2 カスタム・プロセスの最小構成

次の行は、カスタム・プロセスの最小限の構成を表します。カスタム・プロセスの他のすべての構成要素と属性にはデフォルト値が割り当てられます。

<ias-component id="Custom">
   <process-type id="Custom" module-id="CUSTOM">
   <process-set id="Custom" numprocs="1">
      <module-data>
         <category id="start-parameters">
            <data id="start-executable" value="Your start executable here" />
         </category>
      </module-data>
   </process-set>
   </process-type>
</ias-component>

A.3 カスタム・プロセスの完全構成

例A-1に、カスタム・プロセスの完全な構成を示します。これには、カスタム・プロセスに使用できるすべての構成要素および属性が含まれています。

カスタム・プロセスは、他の任意のシステム・コンポーネントの一部とすることができます。このような場合には、例A-1のprocess-type要素は、コンポーネント構成の一部である必要があります。

A.3.1 ping

カスタム・モジュールは、次の2つのいずれかの方法で、カスタム・プロセスのpingを実行するフレームワークを提供します。

HTTP ping
スクリプトping

pingのタイプは、ping-parametersカテゴリ内に適切なデータを指定することによって構成できます。サンプルの構成である例A-1に、HTTP pingを使用したカスタム・プロセスを示します。例A-1は、コンポーネント構成に代替挿入可能なスクリプトpingの例です。

例A-1 カスタム・プロセスの完全構成

<ias-component id="Custom" status="enabled" id-matching="false">
   <environment>
      <variable id="TEST_ENV_VARIABLE" value="/your/test/value" 
      append="false"/>
   </environment>
   <process-type id="Custom" module-id="CUSTOM">
   <process-set id="Custom" restart-on-death="true" numprocs="1">
      <module-data>
         <category id="start-parameters">
            <data id="start-executable" value="Your start executable here" />
            <data id="start-args" value="Your start args here" />
            <data id="append-req-args" value="Arguments appended to the end of the
             start command"/>
            <data id="java-proc" value="true"/>
         </category>
         <category id="stop-parameters">
            <data id="stop-executable" value="Your stop executable here" />
            <data id="stop-args" value="Your stop args here" />
            <data id="append-req-args" value="Arguments appended to the end of the
             stop command"/>
         </category>
         <category id="restart-parameters">
            <data id="restart-executable" value="Your restart executable here"/>
            <data id="restart-args" value="Your restart args here" />
            <data id="append-req-args" value="Arguments appended to the end of the
             restart command"/>
         </category>
         <category id="ping-parameters">
            <data id="ping-type" value="http" />
            <data id="ping-url" value="/your/ping/url" />
            <data id="ping-host" value="abc.company.com" />
            <data id="ping-port" value="7777" />
            <data id="ping-limit" value="3" />
            <data id="ping-timeout" value="300" />
         </category>
         <category id="ready-parameters">
            <data id="use-ping-for-ready" value="false" />
         </category>
      </module-data>
   </process-set>
   </process-type>
</ias-component>

例A-2に、スクリプトを使用したpingの構成を示します。

例A-2 pingタイプ・スクリプト

<category id="ping-parameters">
   <data id="ping-type" value="script" />
   <data id="script-executable" value="Ping executable here" />
   <data id="script-args" value="Ping arguments here " />
</category>

pingを実行することで（使用できる場合）、プロセスが動作可能であるかどうかを判断できます。これは、OPMNが、プロセスの作成後、管理対象プロセスが正常に起動したことの確認を必要としていることを示しています。プロセスは、様々な方法でOPMNに準備ができていることを伝えます。カスタム・モジュールを使用すると、それらのプロセスは、pingを使用して動作可能であることを伝えることができます。カスタム・プロセスに対してping機能を構成する場合、このメカニズムを使用して、そのプロセスの準備ができているかどうかを判断することもできます。プロセスが正常に起動していることのみをカスタム・モジュール側で仮定している場合は、動作可能かどうかを判断するメカニズムを構成しないこともできます。

注意:

pingが構成されている場合、プロセスの作成後すぐにpingが実行されます。プロセスの初期化およびpingへの応答にしばらくかかる場合は、pingを使用して動作可能かどうかを判断することは適切ではありません。その理由は、プロセスがready pingに応答しない場合は、OPMNはそのプロセスが正常に起動しなかったと判断してそのプロセスを停止するからです。

A.4 カスタム・プロセスの属性の説明

この項では、カスタム・プロセスに固有の属性について説明します。この項では、さらに、それぞれの属性についても説明します。

カスタム・プロセスの属性は、次の形式で記述されます。

タイトル: 定義対象の属性名と値です。たとえば、id="Custom"のように記述します。
必須: このフィールドでは、コンポーネントの定義に該当属性が必要か否かを定義します。
デフォルト値: 属性に割り当てられるデフォルト値を定義します。デフォルト値は、インストールされているバージョンのopmn.xmlファイルに格納されるか、該当属性が存在しない場合は内部的に割り当てられます。
有効値: このフィールドでは、必要に応じ、属性の有効値を定義します。たとえば、customのように記述します。
パス: このフィールドでは、該当属性が現れる要素を定義します。たとえば、ias-componentのように記述します。

id="Custom"

必須: ◎
デフォルト値: なし
有効値: 選択した任意のid
パス: ias-component
パス: ias-component/process-type
パス: ias-component/process-type/process-set

このidは必須であり、任意の名前を指定できます。ただし、idは、既存の名前と重複しないようにしてください。

module-id="CUSTOM"

必須: ◎
デフォルト値: なし
有効値: カスタム・プロセスを構成するために付録Aで指定されたmodule-idと同じ。
パス: ias-component/process-type

module-idは、プロセスをモジュールに関連付けます。カスタム・プロセスでは、このidは、カスタム・モジュールのプロセス・モジュール構成で指定されるmodule-idと一致している必要があります。

id="start-parameters"

必須: ◎
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/
category

start-parametersカテゴリには、起動実行可能ファイルおよび起動引数を指定する子要素が含まれます。

id="java-proc"

必須: ×
デフォルト値: false
有効値: trueまたはfalse
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素は、プロセスがJavaプロセスかどうかを指定します。trueに設定した場合は、OPMNは管理対象プロセスのデフォルトのシステム・プロパティをstart-argsに追加します。

id="start-executable"

必須: ◎
デフォルト値: なし
有効値: 実行する有効な実行可能ファイル
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素は、起動する実行可能ファイルの名前を指定します。

id="start-args"

必須: ×
デフォルト値: なし
有効値: 起動実行可能ファイルのデータ要素によって指定される実行可能ファイルへの有効な引数
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素の値は、起動実行可能ファイルへのすべての引数を含む文字列である必要があります。このidに複数のデータ要素を指定しないでください。

id="append-req-args"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/
category

append-req-argsの値は、構成された起動コマンドの末尾に付加されます。

id="stop-parameters"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/
category

stop-parametersカテゴリには、停止実行可能ファイルおよび停止引数を指定する子要素が含まれます。このカテゴリが構成されていない場合、OPMNは、killコマンドを使用してプロセスを停止します。

id="stop-executable"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素は、プロセスの停止に使用される実行可能ファイルの名前を指定します。

id="stop-args"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素の値は、停止実行可能ファイルへのすべての引数を含む文字列である必要があります。このidに複数のデータ要素を指定しないでください。

id="restart-parameters"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/
category

restart-parametersカテゴリには、再起動実行可能ファイルおよび再起動引数を指定する子要素が含まれます。プロセスに明示的な再起動コマンドがある場合、このカテゴリを構成する必要があります。再起動コマンドがない場合、プロセスの再起動が必要なときは、停止コマンドに続いて起動コマンドが実行されます。

再起動データが指定されると、OPMNは、そのプロセスのプロセスIDを再起動後も同じであると見なします。プロセスに使用できる明示的な再起動コマンドがない場合、停止コマンドに続いて起動コマンドが発行されます。この場合はプロセスIDの変更が許容されます。

id="restart-executable"

必須: ×
デフォルト値: なし
有効値: 有効な再起動実行可能ファイル名
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素は、プロセスの再起動に使用される実行可能ファイルの名前を指定します。

id="restart-args"

必須: ×
デフォルト値: なし
有効値: 再起動実行可能ファイルへの有効な引数
パス: ias-component/process-type/process-set/module-data/category/
data

このデータ要素の値は、再起動実行可能ファイルへのすべての引数を含む文字列である必要があります。このidに複数のデータ要素を指定しないでください。

id="append-req-args"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/category

append-req-argsの値は、構成された再起動コマンドの末尾に付加されます。

id="ping-parameters"

必須: ×
デフォルト値: なし
パス: ias-component/process-type/process-set/module-data/
category

HTTPプロトコルを介してpingが実行されるカスタム・プロセスでは、このカテゴリを指定する必要があります。このmodule dataカテゴリは、そのようなpingの実行に必要なすべてのデータで構成されています。

id="ping-type"

必須: ×
デフォルト値: なし
有効値: http、script、integrator
パス: ias-component/process-type/process-set/module-data/category/
data

pingを実行するカスタム・プロセスでは、このmodule dataを指定する必要があります。