Liberty リソースの管理メタデータの設定

admin-metadata.xml ファイルを使用して、サーバー、クラスター、アプリケーション、およびランタイム・リソースの管理メタデータを設定できます。 管理メタデータを使用すると、タグ、所有者、連絡先、メモなどの情報をリソースに関連付けることができます。 メタデータを使用すると、リソース管理を単純化でき、大規模なトポロジーでのリソースについての情報の検出を容易にすることができます。例えば、 サーバーの所有者を示すサーバー・メタデータは、サーバーの変更が必要になった場合に正しい連絡相手を素早く見つけるのに役立ちます。admin-metadata.xml ファイルは XML 形式を使用し、デフォルトでは存在しません。 このファイルを作成して、サーバー構成ディレクトリーまたは Liberty (ランタイム) の etc ディレクトリーに置く必要があります。サポートされるディレクトリーに admin-metadata.xml ファイルを置いた後、 Admin Center でメタデータを表示したり、 アプリケーション・プログラミング・インターフェース (API) を通じてメタデータを拡張したりできます。

手順

  1. admin-metadata.xml ファイルで、特定サーバーのメタデータを設定するか、ランタイム環境内の全サーバーのメタデータを設定するかを決定します。
    server
    サーバー構成ディレクトリー内の admin-metadata.xml ファイルで、サーバーと、そのクラスターおよびアプリケーションのメタデータを設定します。 ファイル・パスは ${wlp.install.dir}/usr/servers/server_name/admin-metadata.xml ですが、server.env ファイルまたはコマンド・ウィンドウで $WLP_USER_DIR 変数が設定されている場合には $WLP_USER_DIR/servers/server_name/admin-metadata.xml になります。
    runtime
    ランタイムの etc ディレクトリー内の admin-metadata.xml ファイルで、ランタイム・リソースのメタデータを設定します。 このファイルは、このランタイム環境を使用するすべてのユーザーから参照可能です。 ファイル・パスは ${wlp.install.dir}/etc/admin-metadata.xml です。 etc ディレクトリーは、デフォルトでは存在しません。 etc ディレクトリーを作成する必要があります。
  2. admin-metadata.xml ファイルに管理メタデータを構成します。
    1. ステップ 1 で決定した場所に、 admin-metadata.xml という名前のテキスト・ファイルを作成します。 ファイルが既に存在する場合は、そのファイルでエディターを開きます。
    2. エディターで、以下のリソース・オブジェクトのいずれかに管理メタデータを指定します。
      • <server> - サーバー・メタデータを 1 つのみ設定します。
      • <cluster> - クラスター・メタデータを 1 つのみ設定します。
      • <application> - アプリケーション・メタデータを任意の数設定します。
      • <runtime> - ランタイム・メタデータを 1 つのみ設定します。
      制約事項: admin-metadata.xml ファイルにホスト・メタデータを設定することはできません。 ホスト・メタデータは、Admin Center、あるいは AdminMetadataManager MBean API またはスクリプトを使用して管理してください。

      各リソース・オブジェクトについて、最大 4 タイプのメタデータを指定します。

      • tag - リソース・オブジェクトに 0 個以上のタグを割り当てます。 タグは、リソースの検索に使用します。
      • owner - リソース・オブジェクトに所有者を 1 つのみ割り当てます。 所有者とは通常、メタデータの責任を持つ人またはエンティティーです。 所有者は、メタデータのキーを提供できます。
      • contact - リソース・オブジェクトに 0 個以上の連絡先を割り当てます。 連絡先は、リソース・オブジェクトに関する情報を提供できる人またはエンティティーです。
      • note - リソース・オブジェクトにメモを 1 つのみ割り当てます。 メモは任意のテキストです。

      ファイルの内容に関するガイダンスについては、例: サーバー構成ディレクトリー内の admin-metadata.xml、 および例: ランタイムの etc ディレクトリー内の admin-metadata.xml を参照してください。

      大文字を含むタグは、集合リポジトリーへのデプロイメントの前に小文字に変換されます。 これにより、admin-metadata.xml ファイル内に <tag>MyTag</tag> とある場合、 Admin Center でこれは mytag と表示されます。

    3. ファイルの変更内容を保存します。

タスクの結果

以下のイベントが発生している場合、サーバー構成ディレクトリー内のサーバー・メタデータが、集合リポジトリーにデプロイされるか、または集合リポジトリーからアンデプロイされます。

  • サーバーが、collective join コマンドにより集合コントローラーに結合される
  • コントローラーまたはメンバー・サーバーが始動する
  • メンバーが、collective remove コマンドにより集合コントローラーから削除される
  • admin-metadata.xml ファイルが変更される

    サーバーの始動後、製品は admin-metadata.xml ファイルをモニターし、 集合リポジトリー内のサーバー・メタデータを動的に更新してファイルの変更を反映します。

    重要: admin-metadata.xml ファイルを削除するときには、サーバーが稼働中であることを確認してください。サーバーが稼働しているときに admin-metadata.xml ファイルが削除された場合、 メタデータはリポジトリーから削除されます。サーバーが停止しているときにファイルから一部のエレメントが削除された場合、 それらのエレメントはサーバー開始時にリポジトリーから削除されます。ただし、サーバーが停止しているときに admin-metadata.xml ファイルが削除された場合は、 サーバー開始時にメタデータはリポジトリーから削除されません。

以下のイベントが発生すると、クラスター・メタデータは集合リポジトリーにデプロイされるか、または集合リポジトリーからアンデプロイされます。

  • クラスター・メンバーの始動時などに、クラスター・メンバーがコントローラーと接続する
  • admin-metadata.xml ファイルのクラスター・メンバーの項目が変更される
  • 最後のクラスター・メンバーの停止時などに、最後のクラスター・メンバーが削除される

以下のイベントが発生している場合、アプリケーション・メタデータが集合リポジトリーにデプロイされます。

  • アプリケーションがサーバーまたはクラスターにインストールされる
  • admin-metadata.xml ファイルのアプリケーションの項目が変更される

以下のイベントが発生している場合、ランタイム・メタデータが集合リポジトリーにデプロイされるか、または集合リポジトリーからアンデプロイされます。

  • サーバーが、collective join コマンドにより集合コントローラーに結合される
  • ランタイム・インストール・ディレクトリー (${wlp.install.dir}) が登録抹消され、アンデプロイされる
  • ファイル・モニターまたは AdminMetadataManager MBean による動的更新が行われない

    製品は、etc ディレクトリー内の admin-metadata.xml ファイルをモニターしません。 集合リポジトリー内のランタイム・メタデータを更新するには、サーバーの再始動が必要です。

注: Admin Center を使用してリポジトリー内のメタデータに行われた変更は、 リソースが集合から完全に削除されない限り、削除されません。

admin-metadata.xml ファイルの例

以下の例は、 サーバー・メタデータとランタイム・メタデータの admin-metadata.xml ファイルを示しています。

例: サーバー構成ディレクトリー内の admin-metadata.xml

<admin-metadata>
    
    <server owner="John Doe">
        <tag>servertag1</tag>
        <tag>servertag2</tag>
        <tag>servertag3</tag>
        <contact>Mike</contact>
        <contact>Fred</contact>
        <contact>Susan</contact>
        <note>This server is the best server.</note>
    </server>
	
    <cluster name="cluster1" owner="Tom Wood">
        <tag>clustertag1</tag>
        <tag>clustertag2</tag>
        <tag>clustertag3</tag>
        <contact>Roger</contact>
        <contact>Steve</contact>
        <contact>David</contact>
        <note>This cluster is the best cluster.</note>
    </cluster>
	
    <application name="app1" owner="Sam Hardison">
        <tag>app1tag1</tag>
        <tag>app1tag2</tag>
        <tag>app1tag3</tag>
        <contact>Jack</contact>
        <contact>Tom</contact>
        <contact>Michael</contact>
        <note>Liberty 8.5.5.x with IBM JDK</note>
    </application>	
	
    <application name="app2" owner="Michael Dell">
        <tag>app2tag1</tag>
        <tag>app2tag2</tag>
        <tag>app2tag3</tag>
        <contact>Susan</contact>
        <contact>Roger</contact>
        <contact>Fred</contact>
        <note>Liberty 8.5.5.x with IBM JDK</note>
    </application>

</admin-metadata>	

例: ランタイムの etc ディレクトリー内の admin-metadata.xml

<admin-metadata>
	
    <runtime owner="Admin Boss">
        <tag>runtimetag1</tag>
        <tag>runtimetag2</tag>
        <tag>runtimetag3</tag> 
        <contact>Steven</contact> 
        <note>Liberty 8.5.5.x with IBM JDK</note> 
    </runtime>

</admin-metadata>

次のタスク

Admin Center で、管理メタデータを表示することができます。 例えば、controller1 という名前の集合コントローラーには、 サーバー構成ディレクトリー $WLP_USER_DIR/servers/controller1 に以下の admin-metadata.xml ファイルがあるとします。

<admin-metadata>
    <server owner="John Doe">
        <tag>controller</tag>
        <tag>replica_controller</tag>
        <contact>Michal</contact>
        <contact>Felix</contact>
        <contact>Travis</contact>
        <contact>Philippa</contact>
        <contact>Amy</contact>
        <note>The first of three replica controllers. At least three replica controllers are needed for high availability.</note>
    </server>
</admin-metadata> 

コントローラーの <featureManager> 構成に <feature>adminCenter-1.0</feature> が指定されている場合、 Admin Center 探索ツールでは、 controller1 サーバーに関する詳細メタデータが以下のように表示されます。

controller1 の admin-metadata.xml ファイル内の管理メタデータが表示された探索ツールのサーバー詳細ビュー

探索ツールでの管理メタデータの表示について詳しくは、『Admin Center での管理メタデータの設定および表示』を参照してください。

また、AdminMetadataManagerMBean のメソッドを使用して、集合リポジトリー内のアプリケーション・メタデータを追加、検索、設定したり、 集合リポジトリーから削除したりすることも可能です。


トピックのタイプを示すアイコン タスク・トピック

ファイル名: tagt_wlp_admin_metadata.html