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