common/onap-tosca-datatype/src/main/resources/globalTypes/openecomp/data.yml

   1 #
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at
   5 #
   6 #      http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13 #
  14
  15 tosca_definitions_version: tosca_simple_yaml_1_1
  16
  17 metadata:
  18   filename: openecomp/data.yml
  19   version: '1.0'
  20
  21 imports:
  22 - openecomp_index:
  23     file: _index.yml
  24
  25 data_types:
  26
  27   org.openecomp.datatypes.network.ProviderNetwork:
  28     derived_from: org.openecomp.datatypes.Root
  29     properties:
  30       is_provider_network:
  31         description: \"true\" testShouldLocatePathWhenResourcePresentInUrlsindicates that this a Neutron provider type of network
  32         type: boolean
  33         required: true
  34       physical_network_name:
  35         description: |
  36           Identifies the NUMA processor cluster to which this physical network interface belongs. NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. \"01\" = NUMA 0, \"11\" = NUMA 1)
  37         type: string
  38         required: false
  39         constraints:
  40         - valid_values:
  41           - Physnet41
  42           - Physnet42
  43           - Physnet43
  44           - Physnet44
  45           - Physnet21
  46           - Physnet22
  47           - sriovnet1
  48           - sriovnet2
  49           - oam
  50       numa:
  51         description: |
  52           PNIC instance within the NUMA processor cluster PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
  53         type: string
  54         required: false
  55         constraints:
  56         - valid_values:
  57           - NUMA 0
  58           - NUMA 1
  59       pnic_instance:
  60         description: PNIC instance within the NUMA processor cluster
  61         type: integer
  62         required: false
  63
  64   org.openecomp.datatypes.DeploymentFlavor:
  65     derived_from: tosca.datatypes.Root
  66     description: Deployment Flavor
  67     properties:
  68       name:
  69         description: Deployment Flavor Name
  70         type: string
  71         status: SUPPORTED
  72         required: true
  73       license_feature_group:
  74         description: license feature group associated with Deployment Flavor
  75         type: org.openecomp.datatypes.FeatureGroup
  76         status: SUPPORTED
  77         required: true
  78       compute_size:
  79         description: Size of VM
  80         type: org.openecomp.datatypes.ComputeFlavor
  81         status: SUPPORTED
  82         required: true
  83
  84   org.openecomp.datatypes.FeatureGroup:
  85     derived_from: tosca.datatypes.Root
  86     description: License Feature Group
  87     properties:
  88       license_feature_group_ref:
  89         description: Deployment Flavor Name
  90         type: string
  91         status: SUPPORTED
  92         required: true
  93       part_number:
  94         description: refrence part number related to feature group
  95         type: string
  96         status: SUPPORTED
  97         required: true
  98
  99   org.openecomp.datatypes.EcompHoming:
 100     derived_from: org.openecomp.datatypes.Root
 101     properties:
 102       ecomp_selected_instance_node_target:
 103         description: |
 104           "true" indicates that the target deployment node for this instance will be auto-selected by OPENECOMP "false" indicates operator-supplied instance target deployment node required (e.g. VID will present a prompt to operator and collect the operator-selected target node for the deployment of this Network instance).
 105         type: boolean
 106         default: false
 107         required: true
 108       homing_policy:
 109         description: Referenc to a service level homing policy that OPENECOMP will use for instance deployment target node
 110         type: string
 111         required: false
 112       instance_node_target:
 113         description: Instance target deployment node
 114         type: string
 115         required: false
 116
 117   org.openecomp.datatypes.AssignmentRequirements:
 118     derived_from: org.openecomp.datatypes.Root
 119     properties:
 120       is_required:
 121         description: |
 122           "true" indicates that assignment is required
 123         type: boolean
 124         default: false
 125         required: true
 126       count:
 127         description: number of assignments required
 128         type: integer
 129         required: false
 130
 131   org.openecomp.resource.abstract.nodes.PNF:
 132     derived_from: tosca.nodes.Root
 133     properties:
 134       nf_function:
 135         type: string
 136       nf_role:
 137         type: string
 138       nf_type:
 139         type: string
 140
 141
 142   org.openecomp.datatypes.network.IpRequirements:
 143     derived_from: org.openecomp.datatypes.Root
 144     properties:
 145       ip_version:
 146         type: integer
 147         required: true
 148         constraints:
 149           - valid_values:
 150             - 4
 151             - 6
 152       ip_count:
 153         description: identifies the number of ip address to assign to the CP from the plan
 154         type: integer
 155         required: false
 156       floating_ip_count:
 157         type: integer
 158         required: false
 159       subnet_role:
 160         type: string
 161         required: false
 162       assingment_method:
 163         type: string
 164         required: true
 165         constraints:
 166           - valid_values:
 167             - fixed
 168             - dhcp
 169       dhcp_enabled:
 170         type: boolean
 171         required: false
 172       ip_count_required:
 173         description: identifies the number of ip address to assign to the CP from the plan
 174         type: org.openecomp.datatypes.AssignmentRequirements
 175         required: false
 176       floating_ip_count_required:
 177         type: org.openecomp.datatypes.AssignmentRequirements
 178         required: false
 179       ip_address_plan_name:
 180         type: string
 181         required: false
 182       vrf_name:
 183         type: string
 184         required: false
 185
 186   org.openecomp.datatypes.network.PhysicalNetwork:
 187     derived_from: org.openecomp.datatypes.Root
 188     properties:
 189       provider_network:
 190         description: true indicates that this a Neutron provider type of network
 191         type: boolean
 192         required: true
 193       physical_network_name:
 194         description: |
 195           Identifies the NUMA processor cluster to which this physical network interface belongs. NUMA instance correlates to the first digit of the Physical Network Name suffix (e.g. "01" = NUMA 0, "11" = NUMA 1)
 196         type: string
 197         required: false
 198         constraints:
 199         - valid_values:
 200           - Physnet-SRIOV-1
 201           - Physnet-SRIOV-2
 202           - Physnet-SRIOV-11
 203           - Physnet-SRIOV-12
 204       numa:
 205         description: |
 206           PNIC instance within the NUMA processor cluster PNIC Instance correlates to the second digit of the Physical Network Name suffix (e.g. "01" = PNIC 1, "02" = "PNIC 2)
 207         type: string
 208         required: false
 209         constraints:
 210         - valid_values:
 211           - NUMA 0
 212           - NUMA 1
 213       pnic_instance:
 214         description: PNIC instance within the NUMA processor cluster
 215         type: integer
 216         required: false
 217
 218   org.openecomp.datatypes.network.VlanRequirements:
 219     derived_from: org.openecomp.datatypes.Root
 220     properties:
 221       vlan_range_plan:
 222         description: reference to a vlan range plan
 223         type: string
 224         required: true
 225       vlan_type:
 226         description: identifies the vlan type (e.g., c-tag)
 227         type: string
 228         required: true
 229         constraints:
 230         - valid_values:
 231           - c-tag
 232           - s-tag
 233       vlan_count:
 234         description: identifies the number of vlan tags to assign to the CP from the plan
 235         type: integer
 236         required: true
 237
 238   org.openecomp.datatypes.ComputeFlavor:
 239     derived_from: tosca.datatypes.Root
 240     description: Compute Flavor (Size)
 241     properties:
 242       name:
 243         description: Compute Flavor Name
 244         type: string
 245         status: SUPPORTED
 246         required: true
 247       num_cpus:
 248         description: Number of cpu
 249         type: integer
 250         status: SUPPORTED
 251         required: true
 252       disk_size:
 253         description: Disk size
 254         type: scalar-unit.size
 255         status: SUPPORTED
 256         required: true
 257       mem_size:
 258         description: Memory size
 259         type: scalar-unit.size
 260         status: SUPPORTED
 261         required: true
 262
 263   org.openecomp.datatypes.network.MacAssignments:
 264     derived_from: org.openecomp.datatypes.Root
 265     properties:
 266       mac_range_plan:
 267         description: reference to a MAC address range plan
 268         type: string
 269         required: true
 270       mac_count:
 271         description: identifies the number of MAC addresses to assign to the CP from the plan
 272         type: integer
 273         required: false
 274       mac_count_required:
 275         description: identifies the number of MAC addresses to assign to the CP from the plan
 276         type: org.openecomp.datatypes.AssignmentRequirements
 277         required: false
 278
 279   org.openecomp.datatypes.network.MacRequirements:
 280     derived_from: org.openecomp.datatypes.Root
 281     properties:
 282       mac_range_plan:
 283         description: reference to a MAC address range plan
 284         type: string
 285         required: true
 286       mac_count:
 287         description: identifies the number of MAC addresses to assign to the CP from the plan
 288         type: integer
 289         required: false
 290       mac_count_required:
 291         description: identifies the number of MAC addresses to assign to the CP from the plan
 292         type: org.openecomp.datatypes.AssignmentRequirements
 293         required: false
 294
 295   org.openecomp.datatypes.network.SubnetAssignments:
 296     derived_from: org.openecomp.datatypes.Root
 297     properties:
 298       ip_network_address_plan:
 299         description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
 300         type: string
 301         required: false
 302       dhcp_enabled:
 303         description: \"true\" indicates the network has 1 or more policies
 304         type: boolean
 305         required: false
 306       ip_version:
 307         description: The IP version of the subnet
 308         type: integer
 309         required: true
 310         constraints:
 311         - valid_values:
 312           - 4
 313           - 6
 314       cidr_mask:
 315         description: The default subnet CIDR mask
 316         type: integer
 317         required: true
 318       min_subnets_count:
 319         description: Quantity of subnets that must be initially assigned
 320         type: integer
 321         default: 1
 322         required: true
 323
 324   org.openecomp.datatypes.Artifact:
 325     derived_from: org.openecomp.datatypes.Root
 326     properties:
 327       artifact_name:
 328         description: Artifcat name
 329         type: string
 330         required: true
 331       artifact_type:
 332         description: Artifcat type
 333         type: string
 334         required: true
 335       artifact_uuid:
 336         description: Artifcat UUID
 337         type: string
 338         required: true
 339       artifact_checksum:
 340         description: Artifact checksum
 341         type: string
 342         required: true
 343       artifact_url:
 344         description: Artifcay URL. Can also include only the file name
 345         type: string
 346         required: true
 347
 348   org.openecomp.datatypes.network.IPv4SubnetAssignments:
 349     derived_from: org.openecomp.datatypes.network.SubnetAssignments
 350     properties:
 351       use_ipv4:
 352         description: Indicates IPv4 subnet assignments
 353         type: boolean
 354         required: true
 355
 356   org.openecomp.datatypes.Root:
 357     derived_from: tosca.datatypes.Root
 358     description: |
 359       The AT&T root Data Type all other Data Types derive from
 360     properties:
 361       supplemental_data:
 362         type: map
 363         entry_schema:
 364           type: string
 365           description: |
 366             A placeholder for missing properties that would be included in future OPENecomp model
 367             versions. fromat <key>:<value>
 368
 369
 370   org.openecomp.datatypes.substitution.SubstitutionFiltering:
 371     derived_from: tosca.datatypes.Root
 372     description: Substitution Filter
 373     properties:
 374       substitute_service_template:
 375         description: Substitute Service Template
 376         type: string
 377         status: SUPPORTED
 378         required: true
 379       index_value:
 380         description: Index value of the substitution service template runtime instance
 381         type: integer
 382         status: SUPPORTED
 383         default: 0
 384         required: false
 385         constraints:
 386         - greater_or_equal: 0
 387       count:
 388         description: Count
 389         type: integer
 390         status: SUPPORTED
 391         default: 1
 392         required: false
 393       scaling_enabled:
 394         description: Indicates whether service scaling is enabled
 395         type: boolean
 396         status: SUPPORTED
 397         default: true
 398         required: false
 399       mandatory:
 400         description: Mandatory
 401         type: boolean
 402         status: SUPPORTED
 403         required: false
 404
 405   org.openecomp.datatypes.network.NetworkFlows:
 406     derived_from: org.openecomp.datatypes.Root
 407     properties:
 408       is_network_policy:
 409         description: true indicates the network has 1 or more policies
 410         type: boolean
 411         default: false
 412         required: false
 413       network_policy:
 414         description: Identifies the specific OPENECOMP Contrail network policy that must be applied to this network (source - from Policy Manager)
 415         type: string
 416         required: false
 417       vpn_binding:
 418         description: Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source - A&AI)
 419         type: string
 420         required: false
 421
 422   org.openecomp.datatypes.network.NetworkAssignments:
 423     derived_from: org.openecomp.datatypes.Root
 424     properties:
 425       ecomp_generated_network_assignment:
 426         description: |
 427           "true" indicates that the network assignments will be auto-generated by OPENECOMP "false" indicates operator-supplied Network assignments file upload is required (e.g. VID will present prompt to operator to upload operator-supplied Network assignments file).
 428         type: boolean
 429         default: false
 430         required: true
 431       network_assignments_file:
 432         description: Filename of the template that specifies all of the configurable name/value pairs of Network assignments in this Network model
 433         type: string
 434         required: false
 435       multi_tenant:
 436         description: true means this network is shared by multiple Openstack tenants
 437         type: boolean
 438         default: true
 439         required: true
 440       min_subnets_count:
 441         description: Quantity of subnets that must be initially assigned
 442         type: integer
 443         required: true
 444       ip_network_address_plan:
 445         description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
 446         type: string
 447         required: true
 448       vlan_network_address_plan:
 449         description: Reference to VLAN or other address plan ID used to assign subnets to this network
 450         type: string
 451         required: true
 452       related_networks:
 453         type: list
 454         description: Related Networks List.
 455         required: false
 456         entry_schema:
 457           type: org.openecomp.datatypes.network.RelatedNetworksAssignments
 458       is_trunked:
 459         type: boolean
 460         required: true
 461         description: \"true\" indicates that network is trunked
 462         default: false
 463
 464   org.openecomp.datatypes.network.RelatedNetworksAssignments:
 465     derived_from: org.openecomp.datatypes.Root
 466     properties:
 467       related_network_role:
 468         description: The network role of the related network, sharing provider network
 469         type: string
 470         required: false
 471
 472   org.openecomp.datatypes.network.IPv6SubnetAssignments:
 473     derived_from: org.openecomp.datatypes.network.SubnetAssignments
 474     properties:
 475       use_ipv6:
 476         description: Indicates IPv6 subnet assignments
 477         type: boolean
 478         required: true
 479
 480   org.openecomp.datatypes.EcompNaming:
 481     derived_from: org.openecomp.datatypes.Root
 482     properties:
 483       ecomp_generated_naming:
 484         description: |
 485           "true" indicates that the name for the instance will be auto-generated by OPENECOMP. "false" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
 486         type: boolean
 487         default: true
 488         required: true
 489       naming_policy:
 490         description: Referenc to naming policy that OPENECOMP will use when the name is auto-generated
 491         type: string
 492         required: false
 493
 494   org.openecomp.datatypes.Naming:
 495     derived_from: org.openecomp.datatypes.Root
 496     properties:
 497       ecomp_generated_naming:
 498         description: |
 499           "true" indicates that the name for the instance will be auto-generated by OPENECOMP. "false" indicates operator-supplied name required (e.g. VID will present prompt to operator and collect the operator-supplied instance name).
 500         type: boolean
 501         default: true
 502         required: true
 503
 504   org.openecomp.datatypes.EcompGeneratedNaming:
 505     derived_from: org.openecomp.datatypes.Naming
 506     properties:
 507       naming_policy:
 508         description: Referenc to naming policy that OPENECOMP will use when the name is auto-generated
 509         type: string
 510         required: false
 511
 512   org.openecomp.datatypes.UserDefinedNaming:
 513     derived_from: org.openecomp.datatypes.Naming
 514     properties:
 515       instance_name:
 516         description: Reference to naming policy that OPENECOMP will use when the name is auto-generated
 517         type: string
 518         required: false
 519
 520   org.openecomp.datatypes.flavors.DeploymentFlavor:
 521     properties:
 522       sp_part_number:
 523         type: string
 524         description: Part number of the feature group associated with the deployment flavor
 525       vendor_info:
 526         type: org.openecomp.datatypes.flavors.VendorInfo
 527         description: Vendor information for the deployment flavor
 528       compute_flavor:
 529         type: org.openecomp.datatypes.flavors.ComputeFlavor
 530         description: Compute information for the deployment flavor
 531       license_flavor:
 532         type: org.openecomp.datatypes.flavors.LicenseFlavor
 533         description: License information for the deployment flavor
 534         required: false
 535
 536   org.openecomp.datatypes.flavors.ComputeFlavor:
 537     properties:
 538       num_cpus:
 539         type: integer
 540         description: Number of CPUs for the VM
 541       disk_size:
 542         type: scalar-unit.size
 543         description: Disk size of the VM
 544       mem_size:
 545         type: scalar-unit.size
 546         description: Memory size of the VM
 547
 548   org.openecomp.datatypes.flavors.LicenseFlavor:
 549     properties:
 550       feature_group_uuid:
 551         type: string
 552         description: Feature Group Id
 553
 554   org.openecomp.datatypes.flavors.VendorInfo:
 555     properties:
 556       manufacturer_reference_number:
 557         type: string
 558         description: Manufacturer reference number
 559       vendor_model:
 560         type: string
 561         description: Vendor License Model Id
 562
 563   org.openecomp.datatypes.ImageInfo:
 564     properties:
 565       software_version:
 566         type: string
 567         description: Image version
 568       file_name:
 569         type: string
 570         description: Image file name
 571       file_hash:
 572         type: string
 573         description: checksum/signature
 574       file_hash_type:
 575         type: string
 576         description: Hash type
 577         required: false
 578         default: md5
 579
 580   # New data types for Port Mirroring
 581   org.openecomp.datatypes.PortMirroringConnectionPointDescription:
 582     properties:
 583       nf_type:
 584         type: string
 585         description: deprecated
 586       nfc_type:
 587         type: string
 588         description: deprecated
 589       nf_naming_code:
 590         type: string
 591       nfc_naming_code:
 592         type: string
 593       network_role:
 594         type: string
 595       pps_capacity:
 596         type: string
 597
 598   tosca.datatypes.network.NetworkInfo:
 599     properties:
 600       network_id:
 601         required: false
 602         type: string
 603       addresses:
 604         entry_schema:
 605           type: string
 606         required: false
 607         type: list
 608       network_name:
 609         required: false
 610         type: string
 611   tosca.datatypes.network.PortInfo:
 612     properties:
 613       port_name:
 614         required: false
 615         type: string
 616       network_id:
 617         required: false
 618         type: string
 619       addresses:
 620         entry_schema:
 621           type: string
 622         required: false
 623         type: list
 624       mac_address:
 625         required: false
 626         type: string
 627       port_id:
 628         required: false
 629         type: string