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