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