Définition de métadonnées d'administration pour les ressources Liberty

Vous pouvez utiliser le fichier admin-metadata.xml pour définir des métadonnées d'administration pour un serveur, un cluster, une application et des ressources d'exécution. Les métadonnées d'administration vous permettent d'associer des informations telles que des étiquettes, des propriétaire, des contacts et des notes, à des resources. Les métadonnées peuvent simplifier la gestion des ressources, et faciliter la recherche d'informations sur les ressources dans de grandes topologies. Par exemple, les métadonnées de serveur qui affichent le propriétaire d'un serveur peuvent vous aider à trouver plus rapidement la personne adéquate à contacter si le serveur requiert des modifications. Le fichier admin-metadata.xml utilise le format XML et n'existe pas par défaut. Vous devez créer le fichier et le placer dans un répertoire de configuration du serveur ou dans le répertoire etc (d'exécution) Liberty. Une fois le fichier admin-metadata.xml placé dans un répertoire pris en charge, vous pouvez afficher les métadonnées dans le Centre d'administration ou augmenter les métadonnées via les interfaces de programme d'application (API).

Procédure

  1. Déterminez si vous voulez que le fichier admin-metadata.xml définisse des métadonnées pour un serveur particulier ou pour tous les serveurs dans l'environnement d'exécution.
    server
    Un fichier admin-metadata.xml dans un répertoire de configuration du serveur définit les métadonnées pour le serveur, son cluster et ses applications. Le chemin d'accès au fichier est ${wlp.install.dir}/usr/servers/server_name/admin-metadata.xml ou, si la variable $WLP_USER_DIR est définie dans un fichier server.env ou une fenêtre de commande, $WLP_USER_DIR/servers/server_name/admin-metadata.xml.
    runtime
    Un fichier admin-metadata.xml dans le répertoire d'exécution etc définit les métadonnées pour les ressources d'exécution. Ce fichier est visible de tous les serveurs qui utilsent l'environnement d'exécution. Le chemin d'accès au fichier est ${wlp.install.dir}/etc/admin-metadata.xml. Le répertoire etc n'existe pas par défaut ; vous devez créer le répertoire etc.
  2. Configurez les données d'administration dans le fichier admin-metadata.xml.
    1. Créez un fichier texte nommé admin-metadata.xml dans l'emplacement déterminé à l'étape 1. Si le fichier existe déjà, ouvrez-le dans un éditeur.
    2. Dans un éditeur, spécifiez les métadonnées d'administration pour les objets ressource suivants :
      • <server> - Ne définissez qu'une seule métadonnée de serveur.
      • <cluster> - Ne définissez qu'une seule métadonnée de cluster.
      • <application> - Définissez un nombre quelconque de métadonnées d'application.
      • <runtime> - Ne définissez qu'une seule métadonnée exécution.
      Restriction : Vous ne pouvez pas définir des métadonnées d'hôte dans un fichier admin-metadata.xml. Vous devez gérer les métadonnées d'hôte à l'aide du Centre d'administration, d'API de bean géré AdminMetadataManager ou de scripts.

      Pour chaque objet ressource, définissez quatre types de métadonnées :

      • tag - Affectez zero ou quelques balises à un objet ressource. Une balise sert à rechercher des ressources.
      • owner - N'afectez qu'un seul propriétaire à un objet ressource. Un propriétaire est généralement une personne ou une entité responsable des métadonnées. Le propriétaire peut fournir une clé pour les métadonnées.
      • contact - Affectez zero ou quelques contacts à un objet ressource. Un contact est une personne ou une entité qui peut fournir des informations sur l'objet de ressource.
      • note - N'affectez qu'une seule remarque à un objet ressource. Une remarque est un texte arbitraire.

      Pour afficher des conseils sur les contenus de fichier, voir Exemple : admin-metadata.xml dans un répertoire de configuration du serveur et Example : admin-metadata.xml dans le répertoire répertoire d'exécution etc.

      Les balises qui contiennent des caractères en majuscules sont convertis en minuscules avant le déploiement dans le référentiel de collectivité. Par conséquent, <tag>MyTag</tag> dans un fichier admin-metadata.xml s'affiche sous la forme mytag dans le Centre d'administration.

    3. Sauvegardez les changements apportés au fichier.

Résultats

Le déploiement ou l'annulation du déploiement des métadonnées de serveur du répertoire de configuration du serveur dans le référentiel de collectivité a lieu lorsque les événements suivants se produisent :

  • Le serveur rejoint le contrôleur de collectivité à l'aide de la commande de collectivité join
  • Le contrôleur ou le serveur membre démarre
  • Un membre est retiré du contrôleur de collectivité à l'aide de la commande de collectivité remove
  • Le fichier admin-metadata.xml est modifié

    Le produit surveille le fichier admin-metadata.xml une fois le serveur démarré et il met à jour de façon dynamique les métadonnées serveur dans le référentiel de collectivité afin de refléter les modifications de fichier.

    Important : Assurez-vous que le serveur est en cours d'exécution lorsque vous supprimez un fichier admin-metadata.xml. Si un fichier admin-metadata.xml est supprimé alors que le serveur est en cours d'exécution, le produit retire les métadonnées du référentiel. Si des éléments sont supprimés du fichier lorsque le serveur est arrêté, le produit retire ces éléments du référentiel au redémarrage du serveur. Toutefois, si le fichier admin-metadata.xml est supprimé alors que le serveur est arrêté, les métadonnées sont retirées du référentiel au redémarrage du serveur.

Le déploiement ou l'annulation du déploiement des métadonnées de cluster dans le référentiel de collectivité a lieu lorsque les événements suivants se produisent :

  • Un membre de cluster se connecte au contrôleur, par exemple au démarrage d'un membre de cluster
  • Le fichier admin-metadata.xml est modifié pour un membre de cluster
  • Le dernier membre de cluster est retiré, par exemple à l'arrêt du dernier membre de cluster

Le déploiement ou l'annulation du déploiement des métadonnées d'application dans le référentiel de collectivité a lieu lorsque les événements suivants se produisent :

  • Une application est installée sur un serveur ou un cluster
  • Le fichier admin-metadata.xml est modifié pour une application

Le déploiement ou l'annulation du déploiement des métadonnées d'exécution dans le référentiel de collectivité a lieu lorsque les événements suivants se produisent :

  • Un serveur rejoint le contrôleur de collectivité à l'aide de la commande de collectivité join
  • L.e répertoire d'installation d'exécution (${wlp.install.dir}) est désenregistré, ce qui entraîne l'annulation du déploiement.
  • Aucune mise à jour dynamique via le moniteur de fichier ou le bean géré AdminMetadataManager

    Le produit ne surveille pas le fichier admin-metadata.xml dans le répertoire etc. Vous devez redémarrer le serveur afin de mettre à jour les métadonnées d'exécution dans le référentiel de collectivité.

Remarque : Les modifications apportées aux métadonnées dans le référentiel avec le Centre d'administration ne sont pas supprimées, sauf si la ressource est entièrement retirée de la collectivité.

Exemple de fichiers admin-metadata.xml

Les exemples ci-après illustrent des fichiers admin-metadata.xml pour les métadonnées server et runtime :

Exemple : admin-metadata.xml dans un répertoire de configuration du serveur

<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>	

Exemple : fichier admin-metadata.xml dans le répertoire d'exécution etc

<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>

Que faire ensuite

Vous pouvez afficher les métadonnées d'administration dans le Centre d'administration. Par exemple, si l'on suppose qu'un contrôleur de collectivité nommé controller1 comporte le fichier admin-metadata.xml dans son répertoire de configuration du serveur , $WLP_USER_DIR/servers/controller1 :

<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> 

Lorsque le contrôleur comporte <feature>adminCenter-1.0</feature> dans sa configuration <featureManager>, l'outil Explore du Centre d'administration affiche les métadonnées dans les détails relatifs au serveur controller1 :

Vue détaillée de serveur de l'outil Explore représentant les métadonnées d'administration dans le fichier admin-metadata.xml du serveur controller1

Pour plus d'informations sur l'affichage des métadonnées d'administration dans l'outil Explore, voir Définition et affichage des métadonnées d'administration dans le Centre d'administration.

Vous pouvez aussi utiliser les méthodes AdminMetadataManagerMBean pour ajouter, extraire et définir des métadonnées d'application dans le référentiel de collectivité, ainsi que pour les retirer de ce dernier.


Icône indiquant le type de rubrique Rubrique Tâche

Nom du fichier : tagt_wlp_admin_metadata.html