Modélisation d'application

ID

Obligatoire. Doit être unique dans tous les plug-in du type de canevas.

libellé

Obligatoire. Libellé de l'entrée dans le panneau Actifs du générateur de canevas.

description

Optionnel. Infobulle pour l'entrée dans le panneau Actifs du générateur de canevas.

type

Obligatoire. Type d'élément que vous définissez. Les valeurs admises sont les suivantes :

• component
• link
• policy

miniature

Optionnel. URL de l'icône 48x48 (relative au plug-in).

image

Optionnel. URL de l'icône 64x64 (relative au plug-in).

attributs

Liste d'objets attribute-def, décrits dans la section suivante.

applicableTo

Pour le type policy uniquement. ID du type de composant auquel la règle peut être associée. Le générateur de canevas n'autorise pas d'autres associations. Utilisez un caractère générique (*) pour permettre l'association de la règle à tout type de composant.

applicationPolicy

Pour le type policy uniquement. Si cet attribut a la valeur true, la règle ne s'affiche que dans les règles disponibles au niveau de l'application et ne peut pas être associée à un composant. Les valeurs admises sont les suivantes :

• true
• false (par défaut)

déprécié

Optionnel. Pour le type component uniquement. Utilisez ce paramètre pour marquer un composant particulier comme obsolète. Le composant s'affiche avec une icône d'avertissement dans le panneau Actifs du générateur de canevas. L'utilisateur peut cliquer sur X pour supprimer le composant de l'application, mais cette modification n'est pas conservée. Les valeurs admises sont les suivantes :

• true (par défaut)
• false

multiplicity

Pour le type link uniquement. Utilisez ce paramètre pour définir le nombre de liens pouvant être créé entre une source et une cible données. Un message d'avertissement s'affiche lors de la création, de l'importation ou du déploiement d'un canevas si la contrainte n'est pas respectée. Les valeurs admises sont les suivantes :

• many-to-many (par défaut)
• one-to-one
• one-to-many

source

Pour le type link uniquement. ID du type de composant à partir duquel le lien peut être créé. Utilisez un caractère générique (*) pour autoriser la création d'un lien à partir de tout type de composant, autre que le composant lui-même, vers ce composant.

Remarque: le caractère générique peut être utilisé uniquement pour le source ou le target d'un composant, mais pas les deux.

cible

Pour le type link uniquement. ID du type de composant vers lequel le lien peut être créé. Utilisez un caractère générique (*) pour autoriser la création d'un lien à partir de tout type de composant, autre que le composant lui-même, vers ce composant.

Remarque: le caractère générique peut être utilisé uniquement pour le source ou le target d'un composant, mais pas les deux.

générateur

Optionnel. Indique si l'attribut s'affiche dans la feuille de propriétés du générateur de canevas. Les valeurs admises sont les suivantes :

• true (par défaut)
• false

déployable

Optionnel. Indique si l'attribut s'affiche dans la page de paramètres de déploiement d'application virtuelle. Les valeurs admises sont les suivantes :

• true
• false (par défaut)

description

Optionnel. Description de la propriété que l'utilisateur peut configurer.

déprécié

Optionnel. Utilisez cette propriété pour marquer un attribut particulier comme obsolète. L'utilisateur reçoit un message indiquant que l'attribut est obsolète au chargement de l'application. Une fois l'application chargée, l'attribut s'affiche avec (Obsolète) en regard du libellé. L'utilisateur peut cliquer sur supprimer pour supprimer l'attribut de l'application. Les valeurs admises sont les suivantes :

• true (par défaut)
• false

displayType

Optionnel. Indique comment les propriétés sont affichées dans l'interface utilisateur. Si vous n'indiquez pas de valeur pour displayType, la valeur par défaut de l'élément type spécifié est utilisé. Les valeurs admises sont :

• radio
• multi-string (pour une zone de texte multiligne)
• password
• percentage
• dynamic (un bouton Ajouter ajoute alors d'autres attributs de manière dynamique)

Si le type est défini sur array, l'affichage du tableau dépend de la spécification de l'élément options.

• Si l'élément options est spécifié, une zone de liste s'affiche et les utilisateurs peuvent effectuer une sélection parmi les valeurs spécifiées.
• Si options n'est pas spécifié, une zone de texte à plusieurs lignes s'affiche et les valeurs du tableau qui sont entrées par l'utilisateur doivent être séparées par une virgule (,).

Extensions

Optionnel. Tableau de chaînes indiquant une extension de fichier valide. Utilisé uniquement lorsque le type est file.

ID

Obligatoire. Doit être unique dans le composant, le lien ou la règle que vous définissez.

invalidMessage

Optionnel. Message à afficher si la valeur spécifiée par l'utilisateur n'est pas valide.

Remarque: un message par défaut s'affiche si invalidMessage n'est pas défini et que l'utilisateur spécifie une valeur qui se trouve en dehors des limites min et max .

libellé

Obligatoire. Libellé affiché dans la feuille de propriétés du générateur de canevas.

max

Optionnel. Valeur maximale pour le type range.

Remarque: un message par défaut s'affiche si invalidMessage n'est pas défini et que l'utilisateur spécifie une valeur max qui est en dehors de cette limite max .

maxOccurs

Optionnel. Indique le nombre de liens pouvant être créés entre un composant source et un composant cible. Si maxOccurs n'est pas utilisé ou que sa valeur est égale à -1, un nombre illimité de liens peuvent être créés entre le composant source et le composant cible. Si une valeur autre que -1 est spécifiée, le nombre de liens entre le composant source et le composant cible ne peut pas dépasser la valeur spécifiée.

min.

Optionnel. Valeur minimale pour le type range.

Remarque: un message par défaut s'affiche si invalidMessage n'est pas défini et que l'utilisateur spécifie une valeur min qui est en dehors de cette limite min .

options

Optionnel. Tableau d'objets pour les valeurs de propriétés que l'utilisateur peut choisir dans l'interface utilisateur. Comme indiqué dans l'exemple de plug-in WebSphere® Application Server , les clés sont name et value.

referenceKey

Optionnel. Nom logique pour une référence de ressource définie dans un fichier WAR, EAR ou OSGi. Pour plus d'informations sur les références de ressource, voir Références de ressource.

referenceType

Optionnel. Sert à identifier le type de référence de ressource dans un fichier WAR, EAR ou OSGi. Pour plus d'informations sur les références de ressource, voir Références de ressource.

regExp

Optionnel. Expression régulière pour la valeur d'entrée de type string. Permet de vérifier s'il existe des entrées valides.

Remarque: Si vous utilisez un caractère spécial dans l'expression régulière, tel que \d, vous devez utiliser un caractère d'échappement: \. Par exemple, "regExp": "\\d{1,3}.\\d{1,3}.\\d{1,3}.\\d{1,3}".

obligatoire

Optionnel. Indique si la propriété est requise. Les valeurs admises sont les suivantes :

• true (par défaut)
• false

type

Obligatoire. Type de propriété. Les types suivants sont pris en charge :

tableau

Une liste de valeurs, qui sont séparées par des virgules. Les valeurs doivent être des chaînes. Par exemple, ["item 1", "item 2", "item 3"].

booléen

Les valeurs admises sont true et false.

String

Le texte qui est placé entre guillemets. Par exemple, "item 1".

nombre

Nombre. Par exemple, 3.1415926.

fichier

Fichier téléchargé par l'utilisateur. Chaîne qui indique le chemin et le nom du fichier. Par exemple, "./archive/test.war".

plage

Sous forme de plage de valeurs. Utilisée avec les propriétés min et max.

objet

Objet. Une valeur valide est un objet JSON.

sampleValue

Optionnel. Valeur par défaut pour la propriété.

{
        "id": "ScalingPolicyofWAS",
        "label": "SCALLING_LABEL",
        "type": "policy",
        "applicableTo": [
            "WAR",
            "EAR",
            "OSGiEBA" 
        ],
        "thumbnail": "appmodel/images/thumbnail/ClusterPolicy_48.png",
        "image": "appmodel/images/ClusterPolicy_64.png",
        "description": "SCALLING_DESCRIPTION",
        "groups": [  
            {
                "id" : "CPUBased",
                "label": "SCALE_POLICY_TYPE_CPU",
                "defaultValue" : false,
                "attributes": [
                    "CPU.Used" ,
                    "triggerTime.CPUBased",
                    "actionType.CPUBased"
                ],
				"description":"SCALE_POLICY_TYPE_CPU_DESCRIPTION" 
            } ,
             {
                "id" : "MemoryBased",
                "label": "SCALE_POLICY_TYPE_MEMORY",
                "defaultValue" : false,
                "attributes": [
                    "Memory.Used" ,
                    "triggerTime.MemoryBased",
                    "actionType.MemoryBased"
                ],
				"description":"SCALE_POLICY_TYPE_MEMORY_DESCRIPTION" 
            } ,
            {
                "id" : "ResponseBased",
                "label": "SCALE_POLICY_TYPE_RESPONSE",
                "defaultValue" : false,
                "attributes": [
                    "WAS_WebApplications.max_service_time",
                    "triggerTime.ResponseBased" 
                ],
				"description":"SCALE_POLICY_TYPE_RESPONSE_DESCRIPTION" 
            } ,
            {              
                "id" : "DBConnectBased",
                "label": "SCALE_POLICY_TYPE_DBCONNECTION",
                "defaultValue" : false,
                "attributes": [              
                    "WAS_JDBCConnectionPools.wait_time",
                    "WAS_JDBCConnectionPools.percent_used" ,
		            "triggerTime.DBConnectBased" 
                ],
				"description":"SCALE_POLICY_TYPE_DBCONNECTION_DESCRIPTION" 
            } 
        ],
        "attributes": [
        	{"id" : "version",
        	 "label" : "no display",
        	  "builder": false,
        	  "type" : "string",
        	  "sampleValue": "1"        	  
        	},
            {
                "id": "CPU.Used",
                "label": "SCALE_ATTRIBUTES_CPU",
                "type": "range",
                "displayType": "percentage",
                "required": false,
                "max": 100,
                "min": 10,
                "sampleValue": [
                    20,
                    80 
                ],
                "description": "SCALE_ATTRIBUTES_CPU_DESCRIPTION" 
            },
       ......
        ] 
    },

ID

Obligatoire. Doit être unique dans le composant, le lien ou la règle que vous définissez.

libellé

Obligatoire. Libellé affiché dans le panneau du générateur de canevas.

attributs

Obligatoire. Liste des ID d'objet attribute-def dans ce composant, lien ou règle.

catégorie

Optionnel. Une catégorie qui est associée au groupe. Les groupes ayant le même nom de catégorie sont exclusifs les uns des autres.

obligatoire

Optionnel. Indique si un groupe est requis. Un groupe avec required = true ne peut pas être désactivé. Les valeurs admises sont :

• true
• false

"attributes"  : [
  {
  "id"          : "archive",
  "label"       : "ARCHIVE_LABEL",
  "description" : "ARCHIVE_DESCRIPTION",
  "type"        : "file",
  "required"    : true,
  "extensions"  : [
  "zip","tgz","tar.gz" 
  ] 
},

 "roles"    : [
  {
  ................
  "name"         : "",
  "type"         : "",
  "parms":{
  "ARCHIVE"   : "$provider.generateArtifactPath( $applicationUrl, ${attributes.archive} )",
  ................

ARCHIVE = maestro.parms['ARCHIVE']
# Download and unzip archive file
logger.debug("Starting to download the archive file...")
maestro.downloadx(ARCHIVE, deployDir)

"attributes": {
		"archive": "artifacts/simple2.war", 
		"ifixes": [
			"https://localhost:9443/services/ifixes/1/scriptArchive.zip",
			"https://localhost:9443/services/ifixes/2/scriptArchive.zip"
		], 
		"ignoreFailedIfix": true,
        ...
}

"roles": [
    {
      ...
      "parms": {
         "ARCHIVE": "$$1",
         "RESTART_INTERVAL": 24,
         "KEYSTORES_PASSWORD": "<xor>BSdtBiUPOwwGbCVr",
         "IFIXES": [
             "https://localhost:9443/services/ifixes/1/scriptArchive.zip",
             "https://localhost:9443/services/ifixes/2/scriptArchive.zip"
         ],
         "USERID": "virtuser",
         "PASSWORD": "$$2",
         "ignoreFailedIfix": "true",
         "hugePageSize": 2048
      },
      ...
    }
]

<resource-ref>
	<res-ref-name>jdbc/TradeDataSource</res-ref-name>
   <res-type>javax.sql.DataSource</res-type>
</resource-ref>

{
  "id"           : "resourceRefs",
  "label"        : "DS_RESOURCE_REFERENCE_LABEL",
  "type"         : "array",
  "required"     :  false,
  "description"  : "DS_RESOURCE_REFERENCE_DESC",
  "referenceType": "javax.sql.DataSource",
  "referenceKey" : "res-ref-name"
}

Extended (type 1)

Cette implémentation est celle par défaut. Pour une règle étendue, les transformations de composant, de règle et de composant sont étroitement associées et sont généralement implémentées et transmises dans le même plug-in. TopologyProvider dispose de la méthode getPolicy(JSONObject component, String policyName) permettant à la transformation de composant d'accéder aux règles et à leurs attributs. Une règle étendue est tout simplement un ensemble supplémentaire d'attributs qui sont ajoutées à un composant. Ces attributs sont traités par la transformation pour le composant.

Règle liée (type 2)

Dans une approche de règle liée, une règle définie dans un plug-in permet d'étendre les capacités d'un composant existant défini dans un autre plug-in.

Dans les deux cas, la définition de la règle est la même dans metadata.json. L'exemple de règle qui est fourni dans le kit de développement de plug-in comporte la règle suivante :

"id": "xpolicy",
"type": "policy",
"applicableTo": [  "Hello"  ],
"attributes": [ {}, ... ]

"id" : "HLPolicy",
"type" : "policy",
"transformAs" : "linked",
"applicableTo" : [ "Hello" 
"attributes" : [
   {
   "id" : "lp1",
   "label" : "linked policy value1",
   "type" : "string",
   "required" : true,
   "sampleValue" : "sample linked policy value"
   }
] 

Le paramètre transformAs est facultatif et peut avoir la valeur extended ou linked. Si transformAs n'est pas spécifié, la règle est traitée en tant que règle étendue par défaut.

• La règle lié est le composant cible
• Le composant source est le composant qui est défini par la valeur applicableTo dans metadata.json.

1. Tous les composants sont transformés avant tous les liens.
2. Si le composant source du lien 1 est le lien cible du lien 2, le lien 1 est transformé avant le lien 2.

• {scriptdir}/Hello/install.py
• {scriptdir}/Hello/configure.py
• {scriptdir}/Hello/start.py

• {scriptdir}/Hello/install.py
• {scriptdir}/Hello/HLPOLICY/install.py
• {scriptdir}/Hello/configure.py
• {scriptdir}/Hello/HLPOLICY/configure.py
• {scriptdir}/Hello/start.py

• Une nouveau composant avec un ensemble de scripts Hello/HLPOLICY doivent être ajoutés à la machine virtuelle.
• Un objet depends doit être ajouté au rôle Hello.

[
    {
        "id": "Hello",
        "label": "Hello_Label",
        "description": "Hello_Desc",
        "thumbnail": "appmodel/images/thumbnail/Hello.png",
        "image": "appmodel/images/Hello.png",
        "type": "component",
        "attributes": [
            {
                "id": "sender",
                "label": "Sender_Label",
                "description": "Sender_Desc",
                "required": true,
                "type": "string",
                "regExp": "\\w*",
                "invalidMessage": "Invalid_Sender_Msg" 
            }          
        ]
    }
]

{
    "Hello": [
        {
            "id": "HelloMessage",
            "label": "Hello_Label",
            "description": "Inlet_Desc",
            "target": "Any",
            "aggregator" : "none",
            "script": "send.py HelloMessage",
            "attributes": [
                {
                    "label": "Username_Label",
                    "type": "string",
                    "id": "UserName",
					"displayType": "string",                    
                    "description": "Inlet_Desc" 
                }
            ] 
        }
      ]
}  

{
	"Hello_Label": "Hello Plugin",
	"Username_Label": "Username",
	"Inlet_Desc":"Deployment inlet to check for registered users",
	"Sender_Label":"Sender Name",
     "Sender_Desc":"Greeting message sender"
}