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