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               },
 298               "target": {
 299                 "title": "onap.datatype.controlloop.Target",
 300                 "type": "object",
 301                 "description": "Definition for a entity in A&AI to perform a control loop operation on",
 302                 "required": [
 303                   "targetType"
 304                 ],
 305                 "properties": {
 306                   "entityIds": {
 307                     "type": "object",
 308                     "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",
 309                     "anyOf": [
 310                       {
 311                         "title": "VNF-vLoadBalancerMS 0",
 312                         "properties": {
 313                           "resourceID": {
 314                             "title": "Resource ID",
 315                             "type": "string",
 316                             "default": "vLoadBalancerMS",
 317                             "readOnly": "True"
 318                           }
 319                         }
 320                       },
 321                       {
 322                         "title": "VFMODULE-Vloadbalancerms..vpkg..module-1",
 323                         "properties": {
 324                           "resourceID": {
 325                             "title": "Resource ID",
 326                             "type": "string",
 327                             "default": "Vloadbalancerms..vpkg..module-1",
 328                             "readOnly": "True"
 329                           },
 330                           "modelInvariantId": {
 331                             "title": "Model Invariant Id (ModelInvariantUUID)",
 332                             "type": "string",
 333                             "default": "ca052563-eb92-4b5b-ad41-9111768ce043",
 334                             "readOnly": "True"
 335                           },
 336                           "modelVersionId": {
 337                             "title": "Model Version Id (ModelUUID)",
 338                             "type": "string",
 339                             "default": "1e725ccc-b823-4f67-82b9-4f4367070dbc",
 340                             "readOnly": "True"
 341                           },
 342                           "modelName": {
 343                             "title": "Model Name",
 344                             "type": "string",
 345                             "default": "Vloadbalancerms..vpkg..module-1",
 346                             "readOnly": "True"
 347                           },
 348                           "modelVersion": {
 349                             "title": "Model Version",
 350                             "type": "string",
 351                             "default": "1",
 352                             "readOnly": "True"
 353                           },
 354                           "modelCustomizationId": {
 355                             "title": "Customization ID",
 356                             "type": "string",
 357                             "default": "1bffdc31-a37d-4dee-b65c-dde623a76e52",
 358                             "readOnly": "True"
 359                           }
 360                         }
 361                       },
 362                       {
 363                         "title": "VFMODULE-Vloadbalancerms..vdns..module-3",
 364                         "properties": {
 365                           "resourceID": {
 366                             "title": "Resource ID",
 367                             "type": "string",
 368                             "default": "Vloadbalancerms..vdns..module-3",
 369                             "readOnly": "True"
 370                           },
 371                           "modelInvariantId": {
 372                             "title": "Model Invariant Id (ModelInvariantUUID)",
 373                             "type": "string",
 374                             "default": "4c10ba9b-f88f-415e-9de3-5d33336047fa",
 375                             "readOnly": "True"
 376                           },
 377                           "modelVersionId": {
 378                             "title": "Model Version Id (ModelUUID)",
 379                             "type": "string",
 380                             "default": "4fa73b49-8a6c-493e-816b-eb401567b720",
 381                             "readOnly": "True"
 382                           },
 383                           "modelName": {
 384                             "title": "Model Name",
 385                             "type": "string",
 386                             "default": "Vloadbalancerms..vdns..module-3",
 387                             "readOnly": "True"
 388                           },
 389                           "modelVersion": {
 390                             "title": "Model Version",
 391                             "type": "string",
 392                             "default": "1",
 393                             "readOnly": "True"
 394                           },
 395                           "modelCustomizationId": {
 396                             "title": "Customization ID",
 397                             "type": "string",
 398                             "default": "bafcdab0-801d-4d81-9ead-f464640a38b1",
 399                             "readOnly": "True"
 400                           }
 401                         }
 402                       },
 403                       {
 404                         "title": "VFMODULE-Vloadbalancerms..base_template..module-0",
 405                         "properties": {
 406                           "resourceID": {
 407                             "title": "Resource ID",
 408                             "type": "string",
 409                             "default": "Vloadbalancerms..base_template..module-0",
 410                             "readOnly": "True"
 411                           },
 412                           "modelInvariantId": {
 413                             "title": "Model Invariant Id (ModelInvariantUUID)",
 414                             "type": "string",
 415                             "default": "921f7c96-ebdd-42e6-81b9-1cfc0c9796f3",
 416                             "readOnly": "True"
 417                           },
 418                           "modelVersionId": {
 419                             "title": "Model Version Id (ModelUUID)",
 420                             "type": "string",
 421                             "default": "63734409-f745-4e4d-a38b-131638a0edce",
 422                             "readOnly": "True"
 423                           },
 424                           "modelName": {
 425                             "title": "Model Name",
 426                             "type": "string",
 427                             "default": "Vloadbalancerms..base_template..module-0",
 428                             "readOnly": "True"
 429                           },
 430                           "modelVersion": {
 431                             "title": "Model Version",
 432                             "type": "string",
 433                             "default": "1",
 434                             "readOnly": "True"
 435                           },
 436                           "modelCustomizationId": {
 437                             "title": "Customization ID",
 438                             "type": "string",
 439                             "default": "86baddea-c730-4fb8-9410-cd2e17fd7f27",
 440                             "readOnly": "True"
 441                           }
 442                         }
 443                       },
 444                       {
 445                         "title": "VFMODULE-Vloadbalancerms..vlb..module-2",
 446                         "properties": {
 447                           "resourceID": {
 448                             "title": "Resource ID",
 449                             "type": "string",
 450                             "default": "Vloadbalancerms..vlb..module-2",
 451                             "readOnly": "True"
 452                           },
 453                           "modelInvariantId": {
 454                             "title": "Model Invariant Id (ModelInvariantUUID)",
 455                             "type": "string",
 456                             "default": "a772a1f4-0064-412c-833d-4749b15828dd",
 457                             "readOnly": "True"
 458                           },
 459                           "modelVersionId": {
 460                             "title": "Model Version Id (ModelUUID)",
 461                             "type": "string",
 462                             "default": "0f5c3f6a-650a-4303-abb6-fff3e573a07a",
 463                             "readOnly": "True"
 464                           },
 465                           "modelName": {
 466                             "title": "Model Name",
 467                             "type": "string",
 468                             "default": "Vloadbalancerms..vlb..module-2",
 469                             "readOnly": "True"
 470                           },
 471                           "modelVersion": {
 472                             "title": "Model Version",
 473                             "type": "string",
 474                             "default": "1",
 475                             "readOnly": "True"
 476                           },
 477                           "modelCustomizationId": {
 478                             "title": "Customization ID",
 479                             "type": "string",
 480                             "default": "96a78aad-4ffb-4ef0-9c4f-deb03bf1d806",
 481                             "readOnly": "True"
 482                           }
 483                         }
 484                       }
 485                     ]
 486                   },
 487                   "targetType": {
 488                     "type": "string",
 489                     "description": "Category for the target type",
 490                     "enum": [
 491                       "VNF",
 492                       "VM",
 493                       "VFMODULE",
 494                       "PNF"
 495                     ]
 496                   }
 497                 }
 498               },
 499               "actor": {
 500                 "type": "string",
 501                 "description": "The actor performing the operation.",
 502                 "enum": [
 503                   "SDNR",
 504                   "SDNC",
 505                   "VFC",
 506                   "SO",
 507                   "APPC",
 508                   "CDS"
 509                 ],
 510                 "options": {
 511                   "enum_titles": [
 512                     "SDNR",
 513                     "SDNC",
 514                     "VFC",
 515                     "SO",
 516                     "APPC"
 517                   ]
 518                 }
 519               },
 520               "operation": {
 521                 "type": "string",
 522                 "description": "The operation the actor is performing.",
 523                 "enum": [
 524                   "BandwidthOnDemand",
 525                   "VF Module Delete",
 526                   "Reroute",
 527                   "VF Module Create",
 528                   "ModifyConfig",
 529                   "Rebuild",
 530                   "Restart",
 531                   "Migrate",
 532                   "Health-Check",
 533                   "resource-assignment",
 534                   "activate",
 535                   "activate-restconf",
 536                   "activate-cli",
 537                   "assign-activate",
 538                   "imperative-test-wf"
 539                 ],
 540                 "options": {
 541                   "enum_titles": [
 542                     "BandwidthOnDemand (SDNC operation)",
 543                     "VF Module Delete (SO operation)",
 544                     "Reroute (SDNC operation)",
 545                     "VF Module Create (SO operation)",
 546                     "ModifyConfig (APPC/VFC operation)",
 547                     "Rebuild (APPC operation)",
 548                     "Restart (APPC operation)",
 549                     "Migrate (APPC operation)",
 550                     "Health-Check (APPC operation)",
 551                     "resource-assignment (CDS operation)",
 552                     "activate (CDS operation)",
 553                     "activate-restconf (CDS operation)",
 554                     "activate-cli (CDS operation)",
 555                     "assign-activate (CDS operation)",
 556                     "imperative-test-wf (CDS operation)"
 557                   ]
 558                 }
 559               }
 560             }
 561           },
 562           "failure_guard": {
 563             "type": "string",
 564             "description": "Points to the operation to invoke when the current operation is blocked due to guard policy enforcement.",
 565             "default": "final_failure_guard"
 566           },
 567           "retries": {
 568             "type": "integer",
 569             "description": "The number of retries the actor should attempt to perform the operation.",
 570             "default": "0"
 571           },
 572           "timeout": {
 573             "type": "integer",
 574             "description": "The amount of time for the actor to perform the operation."
 575           },
 576           "failure_exception": {
 577             "type": "string",
 578             "description": "Points to the operation to invoke when the current operation causes an exception.",
 579             "default": "final_failure_exception"
 580           },
 581           "description": {
 582             "type": "string",
 583             "description": "A user-friendly description of the intent for the operation"
 584           },
 585           "success": {
 586             "type": "string",
 587             "description": "Points to the operation to invoke on success. A value of \"final_success\" indicates and end to the operation.",
 588             "default": "final_success"
 589           }
 590         }
 591       }
 592     },
 593     "trigger": {
 594       "type": "string",
 595       "description": "Initial operation to execute upon receiving an Onset event message for the Control Loop."
 596     },
 597     "timeout": {
 598       "type": "integer",
 599       "description": "Overall timeout for executing all the operations. This timeout should equal or exceed the total\ntimeout for each operation listed.\n"
 600     },
 601     "id": {
 602       "type": "string",
 603       "description": "The unique control loop id."
 604     },
 605     "engineServiceParameters": {
 606       "type": "string",
 607       "description": "The engine parameters like name, instanceCount, policy implementation, parameters etc."
 608     },
 609     "eventOutputParameters": {
 610       "type": "string",
 611       "description": "The event output parameters."
 612     },
 613     "javaProperties": {
 614       "type": "string",
 615       "description": "Name/value pairs of properties to be set for APEX if needed."
 616     },
 617     "eventInputParameters": {
 618       "type": "string",
 619       "description": "The event input parameters."
 620     }
 621   }
 622 }