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