src/test/resources/tosca/new-converter/tosca_apex_with_metadata.json

   1 {
   2   "title": "onap.policies.controlloop.operational.common.Apex",
   3   "type": "object",
   4   "description": "Operational policies for Apex PDP",
   5   "required": [
   6     "id",
   7     "timeout",
   8     "abatement",
   9     "trigger",
  10     "operations",
  11     "engineServiceParameters",
  12     "eventInputParameters",
  13     "eventOutputParameters"
  14   ],
  15   "properties": {
  16     "id": {
  17       "type": "string",
  18       "description": "The unique control loop id."
  19     },
  20     "timeout": {
  21       "type": "integer",
  22       "description": "Overall timeout for executing all the operations. This timeout should equal or exceed the total\ntimeout for each operation listed.\n"
  23     },
  24     "abatement": {
  25       "type": "boolean",
  26       "description": "Whether an abatement event message will be expected for the control loop from DCAE.",
  27       "default": false
  28     },
  29     "trigger": {
  30       "type": "string",
  31       "description": "Initial operation to execute upon receiving an Onset event message for the Control Loop."
  32     },
  33     "operations": {
  34       "type": "array",
  35       "description": "List of operations to be performed when Control Loop is triggered.",
  36       "items": {
  37         "title": "onap.datatype.controlloop.Operation",
  38         "type": "object",
  39         "description": "An operation supported by an actor",
  40         "required": [
  41           "id",
  42           "operation",
  43           "timeout",
  44           "retries"
  45         ],
  46         "properties": {
  47           "id": {
  48             "type": "string",
  49             "description": "Unique identifier for the operation"
  50           },
  51           "description": {
  52             "type": "string",
  53             "description": "A user-friendly description of the intent for the operation"
  54           },
  55           "operation": {
  56             "title": "onap.datatype.controlloop.Actor",
  57             "type": "object",
  58             "description": "An actor/operation/target definition",
  59             "required": [
  60               "actor",
  61               "operation",
  62               "target"
  63             ],
  64             "properties": {
  65               "actor": {
  66                 "type": "string",
  67                 "description": "The actor performing the operation.",
  68                 "enum": [
  69                   "CDS",
  70                   "SDNC",
  71                   "SO"
  72                 ],
  73                 "options": {
  74                   "enum_titles": [
  75                     "CDS",
  76                     "SDNC",
  77                     "SO"
  78                   ]
  79                 }
  80               },
  81               "operation": {
  82                 "type": "string",
  83                 "description": "The operation the actor is performing.",
  84                 "enum": [
  85                   "resource-assignment",
  86                   "activate",
  87                   "activate-restconf",
  88                   "activate-cli",
  89                   "assign-activate",
  90                   "imperative-test-wf"
  91                 ]
  92               },
  93               "target": {
  94                 "title": "onap.datatype.controlloop.Target",
  95                 "type": "object",
  96                 "description": "Definition for a entity in A&AI to perform a control loop operation on",
  97                 "required": [
  98                   "targetType"
  99                 ],
 100                 "properties": {
 101                   "targetType": {
 102                     "type": "string",
 103                     "description": "Category for the target type",
 104                     "enum": [
 105                       "VNF",
 106                       "VM",
 107                       "VFMODULE",
 108                       "PNF"
 109                     ]
 110                   },
 111                   "entityIds": {
 112                     "type": "object",
 113                     "description": "Map of values that identify the resource. If none are provided, it is assumed that the\nentity that generated the ONSET event will be the target.\n",
 114                     "anyOf": [
 115                       {
 116                         "title": "VNF-vLoadBalancerMS 0",
 117                         "properties": {
 118                           "resourceID": {
 119                             "title": "Resource ID",
 120                             "type": "string",
 121                             "default": "vLoadBalancerMS",
 122                             "readOnly": "True"
 123                           }
 124                         }
 125                       },
 126                       {
 127                         "title": "VFMODULE-Vloadbalancerms..vpkg..module-1",
 128                         "properties": {
 129                           "resourceID": {
 130                             "title": "Resource ID",
 131                             "type": "string",
 132                             "default": "Vloadbalancerms..vpkg..module-1",
 133                             "readOnly": "True"
 134                           },
 135                           "modelInvariantId": {
 136                             "title": "Model Invariant Id (ModelInvariantUUID)",
 137                             "type": "string",
 138                             "default": "ca052563-eb92-4b5b-ad41-9111768ce043",
 139                             "readOnly": "True"
 140                           },
 141                           "modelVersionId": {
 142                             "title": "Model Version Id (ModelUUID)",
 143                             "type": "string",
 144                             "default": "1e725ccc-b823-4f67-82b9-4f4367070dbc",
 145                             "readOnly": "True"
 146                           },
 147                           "modelName": {
 148                             "title": "Model Name",
 149                             "type": "string",
 150                             "default": "Vloadbalancerms..vpkg..module-1",
 151                             "readOnly": "True"
 152                           },
 153                           "modelVersion": {
 154                             "title": "Model Version",
 155                             "type": "string",
 156                             "default": "1",
 157                             "readOnly": "True"
 158                           },
 159                           "modelCustomizationId": {
 160                             "title": "Customization ID",
 161                             "type": "string",
 162                             "default": "1bffdc31-a37d-4dee-b65c-dde623a76e52",
 163                             "readOnly": "True"
 164                           }
 165                         }
 166                       },
 167                       {
 168                         "title": "VFMODULE-Vloadbalancerms..vdns..module-3",
 169                         "properties": {
 170                           "resourceID": {
 171                             "title": "Resource ID",
 172                             "type": "string",
 173                             "default": "Vloadbalancerms..vdns..module-3",
 174                             "readOnly": "True"
 175                           },
 176                           "modelInvariantId": {
 177                             "title": "Model Invariant Id (ModelInvariantUUID)",
 178                             "type": "string",
 179                             "default": "4c10ba9b-f88f-415e-9de3-5d33336047fa",
 180                             "readOnly": "True"
 181                           },
 182                           "modelVersionId": {
 183                             "title": "Model Version Id (ModelUUID)",
 184                             "type": "string",
 185                             "default": "4fa73b49-8a6c-493e-816b-eb401567b720",
 186                             "readOnly": "True"
 187                           },
 188                           "modelName": {
 189                             "title": "Model Name",
 190                             "type": "string",
 191                             "default": "Vloadbalancerms..vdns..module-3",
 192                             "readOnly": "True"
 193                           },
 194                           "modelVersion": {
 195                             "title": "Model Version",
 196                             "type": "string",
 197                             "default": "1",
 198                             "readOnly": "True"
 199                           },
 200                           "modelCustomizationId": {
 201                             "title": "Customization ID",
 202                             "type": "string",
 203                             "default": "bafcdab0-801d-4d81-9ead-f464640a38b1",
 204                             "readOnly": "True"
 205                           }
 206                         }
 207                       },
 208                       {
 209                         "title": "VFMODULE-Vloadbalancerms..base_template..module-0",
 210                         "properties": {
 211                           "resourceID": {
 212                             "title": "Resource ID",
 213                             "type": "string",
 214                             "default": "Vloadbalancerms..base_template..module-0",
 215                             "readOnly": "True"
 216                           },
 217                           "modelInvariantId": {
 218                             "title": "Model Invariant Id (ModelInvariantUUID)",
 219                             "type": "string",
 220                             "default": "921f7c96-ebdd-42e6-81b9-1cfc0c9796f3",
 221                             "readOnly": "True"
 222                           },
 223                           "modelVersionId": {
 224                             "title": "Model Version Id (ModelUUID)",
 225                             "type": "string",
 226                             "default": "63734409-f745-4e4d-a38b-131638a0edce",
 227                             "readOnly": "True"
 228                           },
 229                           "modelName": {
 230                             "title": "Model Name",
 231                             "type": "string",
 232                             "default": "Vloadbalancerms..base_template..module-0",
 233                             "readOnly": "True"
 234                           },
 235                           "modelVersion": {
 236                             "title": "Model Version",
 237                             "type": "string",
 238                             "default": "1",
 239                             "readOnly": "True"
 240                           },
 241                           "modelCustomizationId": {
 242                             "title": "Customization ID",
 243                             "type": "string",
 244                             "default": "86baddea-c730-4fb8-9410-cd2e17fd7f27",
 245                             "readOnly": "True"
 246                           }
 247                         }
 248                       },
 249                       {
 250                         "title": "VFMODULE-Vloadbalancerms..vlb..module-2",
 251                         "properties": {
 252                           "resourceID": {
 253                             "title": "Resource ID",
 254                             "type": "string",
 255                             "default": "Vloadbalancerms..vlb..module-2",
 256                             "readOnly": "True"
 257                           },
 258                           "modelInvariantId": {
 259                             "title": "Model Invariant Id (ModelInvariantUUID)",
 260                             "type": "string",
 261                             "default": "a772a1f4-0064-412c-833d-4749b15828dd",
 262                             "readOnly": "True"
 263                           },
 264                           "modelVersionId": {
 265                             "title": "Model Version Id (ModelUUID)",
 266                             "type": "string",
 267                             "default": "0f5c3f6a-650a-4303-abb6-fff3e573a07a",
 268                             "readOnly": "True"
 269                           },
 270                           "modelName": {
 271                             "title": "Model Name",
 272                             "type": "string",
 273                             "default": "Vloadbalancerms..vlb..module-2",
 274                             "readOnly": "True"
 275                           },
 276                           "modelVersion": {
 277                             "title": "Model Version",
 278                             "type": "string",
 279                             "default": "1",
 280                             "readOnly": "True"
 281                           },
 282                           "modelCustomizationId": {
 283                             "title": "Customization ID",
 284                             "type": "string",
 285                             "default": "96a78aad-4ffb-4ef0-9c4f-deb03bf1d806",
 286                             "readOnly": "True"
 287                           }
 288                         }
 289                       }
 290                     ]
 291                   }
 292                 }
 293               },
 294               "payload": {
 295                 "type": "object",
 296                 "description": "Name/value pairs of payload information passed by Policy to the actor",
 297                 "anyOf": [
 298                   {
 299                     "title": "resource-assignment",
 300                     "properties": {
 301                       "artifact_name": "baseconfiguration",
 302                       "artifact_version": "1.0.0",
 303                       "mode": "async",
 304                       "data": {
 305                         "resource-assignment-properties": {
 306                           "request-id": "",
 307                           "service-instance-id": "",
 308                           "vnf-id": "",
 309                           "action-name": "",
 310                           "scope-type": "",
 311                           "hostname": "",
 312                           "vnf_name": ""
 313                         }
 314                       }
 315                     }
 316                   },
 317                   {
 318                     "title": "activate",
 319                     "properties": {
 320                       "artifact_name": "baseconfiguration",
 321                       "artifact_version": "1.0.0",
 322                       "mode": "async",
 323                       "data": {
 324                         "resource-assignment-properties": {
 325                           "request-id": "",
 326                           "service-instance-id": "",
 327                           "vnf-id": "",
 328                           "action-name": "",
 329                           "scope-type": "",
 330                           "hostname": "",
 331                           "vnf_name": ""
 332                         }
 333                       }
 334                     }
 335                   },
 336                   {
 337                     "title": "activate-restconf",
 338                     "properties": {
 339                       "artifact_name": "baseconfiguration",
 340                       "artifact_version": "1.0.0",
 341                       "mode": "async",
 342                       "data": {
 343                         "resource-assignment-properties": {
 344                           "request-id": "",
 345                           "service-instance-id": "",
 346                           "vnf-id": "",
 347                           "action-name": "",
 348                           "scope-type": "",
 349                           "hostname": "",
 350                           "vnf_name": ""
 351                         }
 352                       }
 353                     }
 354                   },
 355                   {
 356                     "title": "activate-cli",
 357                     "properties": {
 358                       "artifact_name": "baseconfiguration",
 359                       "artifact_version": "1.0.0",
 360                       "mode": "async",
 361                       "data": {
 362                         "resource-assignment-properties": {
 363                           "request-id": "",
 364                           "service-instance-id": "",
 365                           "vnf-id": "",
 366                           "action-name": "",
 367                           "scope-type": "",
 368                           "hostname": "",
 369                           "vnf_name": ""
 370                         }
 371                       }
 372                     }
 373                   },
 374                   {
 375                     "title": "assign-activate",
 376                     "properties": {
 377                       "artifact_name": "baseconfiguration",
 378                       "artifact_version": "1.0.0",
 379                       "mode": "async",
 380                       "data": {
 381                         "resource-assignment-properties": {
 382                           "request-id": "",
 383                           "service-instance-id": "",
 384                           "vnf-id": "",
 385                           "action-name": "",
 386                           "scope-type": "",
 387                           "hostname": "",
 388                           "vnf_name": ""
 389                         }
 390                       }
 391                     }
 392                   },
 393                   {
 394                     "title": "imperative-test-wf",
 395                     "properties": {
 396                       "artifact_name": "baseconfiguration",
 397                       "artifact_version": "1.0.0",
 398                       "mode": "async",
 399                       "data": {
 400                         "resource-assignment-properties": {
 401                           "request-id": "",
 402                           "service-instance-id": "",
 403                           "vnf-id": "",
 404                           "action-name": "",
 405                           "scope-type": "",
 406                           "hostname": "",
 407                           "vnf_name": ""
 408                         }
 409                       }
 410                     }
 411                   }
 412                 ]
 413               }
 414             }
 415           },
 416           "timeout": {
 417             "type": "integer",
 418             "description": "The amount of time for the actor to perform the operation."
 419           },
 420           "retries": {
 421             "type": "integer",
 422             "description": "The number of retries the actor should attempt to perform the operation.",
 423             "default": 0
 424           },
 425           "success": {
 426             "type": "string",
 427             "description": "Points to the operation to invoke on success. A value of \"final_success\" indicates and end to the operation.",
 428             "default": "final_success"
 429           },
 430           "failure": {
 431             "type": "string",
 432             "description": "Points to the operation to invoke on Actor operation failure.",
 433             "default": "final_failure"
 434           },
 435           "failure_timeout": {
 436             "type": "string",
 437             "description": "Points to the operation to invoke when the time out for the operation occurs.",
 438             "default": "final_failure_timeout"
 439           },
 440           "failure_retries": {
 441             "type": "string",
 442             "description": "Points to the operation to invoke when the current operation has exceeded its max retries.",
 443             "default": "final_failure_retries"
 444           },
 445           "failure_exception": {
 446             "type": "string",
 447             "description": "Points to the operation to invoke when the current operation causes an exception.",
 448             "default": "final_failure_exception"
 449           },
 450           "failure_guard": {
 451             "type": "string",
 452             "description": "Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.",
 453             "default": "final_failure_guard"
 454           }
 455         }
 456       }
 457     },
 458     "engineServiceParameters": {
 459       "type": "string",
 460       "description": "The engine parameters like name, instanceCount, policy implementation, parameters etc."
 461     },
 462     "eventInputParameters": {
 463       "type": "string",
 464       "description": "The event input parameters."
 465     },
 466     "eventOutputParameters": {
 467       "type": "string",
 468       "description": "The event output parameters."
 469     },
 470     "javaProperties": {
 471       "type": "string",
 472       "description": "Name/value pairs of properties to be set for APEX if needed."
 473     }
 474   }
 475 }