openecomp-be/backend/openecomp-sdc-vendor-software-product-manager/src/test/resources/extractServiceComposition/toscaGlobalServiceTemplates/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_openecomp_1_0
  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\" indicates 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
  51       numa:
  52         description: |
  53           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)
  54         type: string
  55         required: false
  56         constraints:
  57         - valid_values:
  58           - NUMA 0
  59           - NUMA 1
  60       pnic_instance:
  61         description: PNIC instance within the NUMA processor cluster
  62         type: integer
  63         required: false
  64
  65   org.openecomp.datatypes.DeploymentFlavor:
  66     derived_from: tosca.datatypes.Root
  67     description: Deployment Flavor
  68     properties:
  69       name:
  70         description: Deployment Flavor Name
  71         type: string
  72         status: SUPPORTED
  73         required: true
  74       license_feature_group:
  75         description: license feature group associated with Deployment Flavor
  76         type: org.openecomp.datatypes.FeatureGroup
  77         status: SUPPORTED
  78         required: true
  79       compute_size:
  80         description: Size of VM
  81         type: org.openecomp.datatypes.ComputeFlavor
  82         status: SUPPORTED
  83         required: true
  84
  85   org.openecomp.datatypes.FeatureGroup:
  86     derived_from: tosca.datatypes.Root
  87     description: License Feature Group
  88     properties:
  89       license_feature_group_ref:
  90         description: Deployment Flavor Name
  91         type: string
  92         status: SUPPORTED
  93         required: true
  94       part_number:
  95         description: refrence part number related to feature group
  96         type: string
  97         status: SUPPORTED
  98         required: true
  99
 100   org.openecomp.datatypes.EcompHoming:
 101     derived_from: org.openecomp.datatypes.Root
 102     properties:
 103       ecomp_selected_instance_node_target:
 104         description: |
 105           "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).
 106         type: boolean
 107         default: false
 108         required: true
 109       homing_policy:
 110         description: Referenc to a service level homing policy that OPENECOMP will use for instance deployment target node
 111         type: string
 112         required: false
 113       instance_node_target:
 114         description: Instance target deployment node
 115         type: string
 116         required: false
 117
 118   org.openecomp.datatypes.AssignmentRequirements:
 119     derived_from: org.openecomp.datatypes.Root
 120     properties:
 121       is_required:
 122         description: |
 123           "true" indicates that assignment is required
 124         type: boolean
 125         default: false
 126         required: true
 127       count:
 128         description: number of assignments required
 129         type: integer
 130         required: false
 131
 132
 133   org.openecomp.datatypes.network.IpRequirements:
 134     derived_from: org.openecomp.datatypes.Root
 135     properties:
 136       ip_version:
 137         type: integer
 138         required: true
 139         constraints:
 140         - valid_values:
 141           - 4
 142           - 6
 143       ip_count:
 144         description: identifies the number of ip address to assign to the CP from the plan
 145         type: org.openecomp.datatypes.AssignmentRequirements
 146         required: true
 147       floating_ip_count:
 148         type: org.openecomp.datatypes.AssignmentRequirements
 149         required: false
 150       subnet_role:
 151         type: string
 152         required: false
 153       assingment_method:
 154         type: string
 155         required: true
 156         constraints:
 157         - valid_values:
 158           - fixed
 159           - dhcp
 160
 161   org.openecomp.datatypes.network.PhysicalNetwork:
 162     derived_from: org.openecomp.datatypes.Root
 163     properties:
 164       provider_network:
 165         description: true indicates that this a Neutron provider type of network
 166         type: boolean
 167         required: true
 168       physical_network_name:
 169         description: |
 170           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)
 171         type: string
 172         required: false
 173         constraints:
 174         - valid_values:
 175           - Physnet-SRIOV-1
 176           - Physnet-SRIOV-2
 177           - Physnet-SRIOV-11
 178           - Physnet-SRIOV-12
 179       numa:
 180         description: |
 181           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)
 182         type: string
 183         required: false
 184         constraints:
 185         - valid_values:
 186           - NUMA 0
 187           - NUMA 1
 188       pnic_instance:
 189         description: PNIC instance within the NUMA processor cluster
 190         type: integer
 191         required: false
 192
 193   org.openecomp.datatypes.network.VlanRequirements:
 194     derived_from: org.openecomp.datatypes.Root
 195     properties:
 196       vlan_range_plan:
 197         description: reference to a vlan range plan
 198         type: string
 199         required: true
 200       vlan_type:
 201         description: identifies the vlan type (e.g., c-tag)
 202         type: string
 203         required: true
 204         constraints:
 205         - valid_values:
 206           - c-tag
 207           - s-tag
 208       vlan_count:
 209         description: identifies the number of vlan tags to assign to the CP from the plan
 210         type: integer
 211         required: true
 212
 213   org.openecomp.datatypes.ComputeFlavor:
 214     derived_from: tosca.datatypes.Root
 215     description: Compute Flavor (Size)
 216     properties:
 217       name:
 218         description: Compute Flavor Name
 219         type: string
 220         status: SUPPORTED
 221         required: true
 222       num_cpus:
 223         description: Number of cpu
 224         type: integer
 225         status: SUPPORTED
 226         required: true
 227       disk_size:
 228         description: Disk size
 229         type: scalar-unit.size
 230         status: SUPPORTED
 231         required: true
 232       mem_size:
 233         description: Memory size
 234         type: scalar-unit.size
 235         status: SUPPORTED
 236         required: true
 237
 238   org.openecomp.datatypes.network.MacAssignments:
 239     derived_from: org.openecomp.datatypes.Root
 240     properties:
 241       mac_range_plan:
 242         description: reference to a MAC address range plan
 243         type: string
 244         required: true
 245       mac_count:
 246         description: identifies the number of MAC addresses to assign to the CP from the plan
 247         type: integer
 248         required: true
 249
 250   org.openecomp.datatypes.network.MacRequirements:
 251     derived_from: org.openecomp.datatypes.Root
 252     properties:
 253       mac_range_plan:
 254         description: reference to a MAC address range plan
 255         type: string
 256         required: true
 257       mac_count:
 258         description: identifies the number of MAC addresses to assign to the CP from the plan
 259         type: org.openecomp.datatypes.AssignmentRequirements
 260         required: true
 261
 262   org.openecomp.datatypes.network.SubnetAssignments:
 263     derived_from: org.openecomp.datatypes.Root
 264     properties:
 265       ip_network_address_plan:
 266         description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
 267         type: string
 268         required: false
 269       dhcp_enabled:
 270         description: \"true\" indicates the network has 1 or more policies
 271         type: boolean
 272         required: false
 273       ip_version:
 274         description: The IP version of the subnet
 275         type: integer
 276         required: true
 277         constraints:
 278         - valid_values:
 279           - 4
 280           - 6
 281       cidr_mask:
 282         description: The default subnet CIDR mask
 283         type: integer
 284         required: true
 285       min_subnets_count:
 286         description: Quantity of subnets that must be initially assigned
 287         type: integer
 288         default: 1
 289         required: true
 290
 291   org.openecomp.datatypes.Artifact:
 292     derived_from: org.openecomp.datatypes.Root
 293     properties:
 294       artifact_name:
 295         description: Artifcat name
 296         type: string
 297         required: true
 298       artifact_type:
 299         description: Artifcat type
 300         type: string
 301         required: true
 302       artifact_uuid:
 303         description: Artifcat UUID
 304         type: string
 305         required: true
 306       artifact_checksum:
 307         description: Artifact checksum
 308         type: string
 309         required: true
 310       artifact_url:
 311         description: Artifcay URL. Can also include only the file name
 312         type: string
 313         required: true
 314
 315   org.openecomp.datatypes.network.IPv4SubnetAssignments:
 316     derived_from: org.openecomp.datatypes.network.SubnetAssignments
 317     properties:
 318       use_ipv4:
 319         description: Indicates IPv4 subnet assignments
 320         type: boolean
 321         required: true
 322
 323   org.openecomp.datatypes.Root:
 324     derived_from: tosca.datatypes.Root
 325     description: |
 326       The AT&T root Data Type all other Data Types derive from
 327     properties:
 328       supplemental_data:
 329         type: map
 330         entry_schema:
 331           type: string
 332           description: |
 333             A placeholder for missing properties that would be included in future openecomp model
 334             versions. fromat <key>:<value>
 335
 336
 337   org.openecomp.datatypes.substitution.SubstitutionFiltering:
 338     derived_from: tosca.datatypes.Root
 339     description: Substitution Filter
 340     properties:
 341       substitute_service_template:
 342         description: Substitute Service Template
 343         type: string
 344         status: SUPPORTED
 345         required: true
 346       index_value:
 347         description: Index value of the substitution service template runtime instance
 348         type: integer
 349         status: SUPPORTED
 350         default: 0
 351         required: false
 352         constraints:
 353         - greater_or_equal: 0
 354       count:
 355         description: Count
 356         type: string
 357         status: SUPPORTED
 358         default: 1
 359         required: false
 360       scaling_enabled:
 361         description: Indicates whether service scaling is enabled
 362         type: boolean
 363         status: SUPPORTED
 364         default: true
 365         required: false
 366       mandatory:
 367         description: Mandatory
 368         type: boolean
 369         status: SUPPORTED
 370         required: false
 371
 372   org.openecomp.datatypes.network.NetworkFlows:
 373     derived_from: org.openecomp.datatypes.Root
 374     properties:
 375       is_network_policy:
 376         description: true indicates the network has 1 or more policies
 377         type: boolean
 378         default: false
 379         required: false
 380       network_policy:
 381         description: Identifies the specific OPENECOMP Contrail network policy that must be applied to this network (source - from Policy Manager)
 382         type: string
 383         required: false
 384       vpn_binding:
 385         description: Identifies the specific VPN Binding entry in A&AI that must be applied when creating this network (source - A&AI)
 386         type: string
 387         required: false
 388
 389   org.openecomp.datatypes.network.NetworkAssignments:
 390     derived_from: org.openecomp.datatypes.Root
 391     properties:
 392       ecomp_generated_network_assignment:
 393         description: |
 394           "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).
 395         type: boolean
 396         default: false
 397         required: true
 398       network_assignments_file:
 399         description: Filename of the template that specifies all of the configurable name/value pairs of Network assignments in this Network model
 400         type: string
 401         required: false
 402       multi_tenant:
 403         description: true means this network is shared by multiple Openstack tenants
 404         type: boolean
 405         default: true
 406         required: true
 407       min_subnets_count:
 408         description: Quantity of subnets that must be initially assigned
 409         type: integer
 410         required: true
 411       ip_network_address_plan:
 412         description: Reference to EIPAM, VLAN or other address plan ID used to assign subnets to this network
 413         type: string
 414         required: true
 415       vlan_network_address_plan:
 416         description: Reference to VLAN or other address plan ID used to assign subnets to this network
 417         type: string
 418         required: true
 419       related_networks:
 420         type: list
 421         description: Related Networks List.
 422         required: false
 423         entry_schema:
 424           type: org.openecomp.datatypes.network.RelatedNetworksAssignments
 425       is_trunked:
 426         type: boolean
 427         required: true
 428         description: \"true\" indicates that network is trunked
 429         default: false
 430
 431   org.openecomp.datatypes.network.RelatedNetworksAssignments:
 432     derived_from: org.openecomp.datatypes.Root
 433     properties:
 434       related_network_role:
 435         description: The network role of the related network, sharing provider network
 436         type: string
 437         required: false
 438
 439   org.openecomp.datatypes.network.IPv6SubnetAssignments:
 440     derived_from: org.openecomp.datatypes.network.SubnetAssignments
 441     properties:
 442       use_ipv6:
 443         description: Indicates IPv6 subnet assignments
 444         type: boolean
 445         required: true
 446
 447   org.openecomp.datatypes.EcompNaming:
 448     derived_from: org.openecomp.datatypes.Root
 449     properties:
 450       ecomp_generated_naming:
 451         description: |
 452           "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).
 453         type: boolean
 454         default: true
 455         required: true
 456       naming_policy:
 457         description: Referenc to naming policy that OPENECOMP will use when the name is auto-generated
 458         type: string
 459         required: false
 460
 461   org.openecomp.datatypes.Naming:
 462     derived_from: org.openecomp.datatypes.Root
 463     properties:
 464       ecomp_generated_naming:
 465         description: |
 466           "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).
 467         type: boolean
 468         default: true
 469         required: true
 470
 471   org.openecomp.datatypes.EcompGeneratedNaming:
 472     derived_from: org.openecomp.datatypes.Naming
 473     properties:
 474       naming_policy:
 475         description: Referenc to naming policy that OPENECOMP will use when the name is auto-generated
 476         type: string
 477         required: false
 478
 479   org.openecomp.datatypes.UserDefinedNaming:
 480     derived_from: org.openecomp.datatypes.Naming
 481     properties:
 482       instance_name:
 483         description: Reference to naming policy that OPENECOMP will use when the name is auto-generated
 484         type: string
 485         required: false
 486