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