azure/aria/aria-extension-cloudify/src/aria/extensions/aria_extension_tosca/profiles/tosca-simple-nfv-1.0/data.yaml

   1 # Licensed to the Apache Software Foundation (ASF) under one or more
   2 # contributor license agreements.  See the NOTICE file distributed with
   3 # this work for additional information regarding copyright ownership.
   4 # The ASF licenses this file to You under the Apache License, Version 2.0
   5 # (the "License"); you may not use this file except in compliance with
   6 # the License.  You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 data_types:
  17
  18   tosca.datatypes.nfv.L2AddressData:
  19     # TBD
  20     _extensions:
  21       shorthand_name: L2AddressData
  22       type_qualified_name: tosca:L2AddressData
  23       specification: tosca-simple-nfv-1.0
  24       specification_section: 5.3.1
  25       specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896055'
  26
  27   tosca.datatypes.nfv.L3AddressData:
  28     _extensions:
  29       shorthand_name: L3AddressData
  30       type_qualified_name: tosca:L3AddressData
  31       specification: tosca-simple-nfv-1.0
  32       specification_section: 5.3.2
  33       specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896056'
  34     description: >-
  35       The L3AddressData type is a complex TOSCA data type used to describe L3AddressData information
  36       element as defined in [ETSI GS NFV-IFA 011], it provides the information on the IP addresses
  37       to be assigned to the connection point instantiated from the parent Connection Point
  38       Descriptor.
  39     derived_from: tosca.datatypes.Root
  40     properties:
  41       ip_address_assignment:
  42         description: >-
  43           Specify if the address assignment is the responsibility of management and orchestration
  44           function or not. If it is set to True, it is the management and orchestration function
  45           responsibility.
  46         type: boolean
  47         required: true
  48       floating_ip_activated:
  49         description: Specify if the floating IP scheme is activated on the Connection Point or not.
  50         type: boolean
  51         required: true
  52       ip_address_type:
  53         description: >-
  54           Define address type. The address type should be aligned with the address type supported by
  55           the layer_protocol properties of the parent VnfExtCpd.
  56         type: string
  57         required: false
  58         constraints:
  59           - valid_values: [ ipv4, ipv6 ]
  60       number_of_ip_address:
  61         description: >-
  62           Minimum number of IP addresses to be assigned.
  63         type: integer
  64         required: false
  65
  66   tosca.datatypes.nfv.AddressData:
  67     _extensions:
  68       shorthand_name: AddressData
  69       type_qualified_name: tosca:AddressData
  70       specification: tosca-simple-nfv-1.0
  71       specification_section: 5.3.3
  72       specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896057'
  73     description: >-
  74       The AddressData type is a complex TOSCA data type used to describe AddressData information
  75       element as defined in [ETSI GS NFV-IFA 011], it provides information on the addresses to be
  76       assigned to the connection point(s) instantiated from a Connection Point Descriptor.
  77     derived_from: tosca.datatypes.Root
  78     properties:
  79       address_type:
  80         description: >-
  81           Describes the type of the address to be assigned to the connection point instantiated from
  82           the parent Connection Point Descriptor. The content type shall be aligned with the address
  83           type supported by the layerProtocol property of the parent Connection Point Descriptor.
  84         type: string
  85         required: true
  86         constraints:
  87           - valid_values: [ mac_address, ip_address ]
  88       l2_address_data:
  89         # Shall be present when the addressType is mac_address.
  90         description: >-
  91           Provides the information on the MAC addresses to be assigned to the connection point(s)
  92           instantiated from the parent Connection Point Descriptor.
  93         type: tosca.datatypes.nfv.L2AddressData # Empty in "GS NFV IFA011 V0.7.3"
  94         required: false
  95       l3_address_data:
  96         # Shall be present when the addressType is ip_address.
  97         description: >-
  98           Provides the information on the IP addresses to be assigned to the connection point
  99           instantiated from the parent Connection Point Descriptor.
 100         type: tosca.datatypes.nfv.L3AddressData
 101         required: false
 102
 103   tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
 104     _extensions:
 105       shorthand_name: VirtualNetworkInterfaceRequirements
 106       type_qualified_name: tosca:VirtualNetworkInterfaceRequirements
 107       specification: tosca-simple-nfv-1.0
 108       specification_section: 5.3.4
 109       specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896058'
 110     description: >-
 111       The VirtualNetworkInterfaceRequirements type is a complex TOSCA data type used to describe
 112       VirtualNetworkInterfaceRequirements information element as defined in [ETSI GS NFV-IFA 011],
 113       it provides the information to specify requirements on a virtual network interface realising the
 114       CPs instantiated from this CPD.
 115     derived_from: tosca.datatypes.Root
 116     properties:
 117       name:
 118         description: >-
 119           Provides a human readable name for the requirement.
 120         type: string
 121         required: false
 122       description:
 123         description: >-
 124           Provides a human readable description for the requirement.
 125         type: string
 126         required: false
 127       support_mandatory:
 128         description: >-
 129           Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation
 130           or desirable (FALSE).
 131         type: boolean
 132         required: false
 133       requirement:
 134         description: >-
 135           Specifies a requirement such as the support of SR-IOV, a particular data plane
 136           acceleration library, an API to be exposed by a NIC, etc.
 137         type: string # ARIA NOTE: the spec says "not specified", but TOSCA requires a type
 138         required: true
 139
 140   tosca.datatypes.nfv.ConnectivityType:
 141     _extensions:
 142       shorthand_name: ConnectivityType
 143       type_qualified_name: tosca:ConnectivityType
 144       specification: tosca-simple-nfv-1.0
 145       specification_section: 5.3.5
 146       specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896059'
 147     description: >-
 148       The TOSCA ConnectivityType type is a complex TOSCA data type used to describe ConnectivityType
 149       information element as defined in [ETSI GS NFV-IFA 011].
 150     derived_from: tosca.datatypes.Root
 151     properties:
 152       layer_protocol:
 153         description: >-
 154           Identifies the protocol this VL gives access to (ethernet, mpls, odu2, ipv4, ipv6,
 155           pseudo_wire).
 156         type: string
 157         required: true
 158         constraints:
 159           - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ]
 160       flow_pattern:
 161         description: >-
 162           Identifies the flow pattern of the connectivity (Line, Tree, Mesh).
 163         type: string
 164         required: false
 165
 166   tosca.datatypes.nfv.RequestedAdditionalCapability:
 167     _extensions:
 168       shorthand_name: RequestedAdditionalCapability
 169       type_qualified_name: tosca:RequestedAdditionalCapability
 170       specification: tosca-simple-nfv-1.0
 171       specification_section: 5.3.6
 172       specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896060'
 173     description: >-
 174       RequestAdditionalCapability describes additional capability for a particular VDU.
 175     derived_from: tosca.datatypes.Root
 176     properties:
 177       request_additional_capability_name:
 178         description: >-
 179           Identifies a requested additional capability for the VDU.
 180         type: string
 181         required: true
 182       support_mandatory:
 183         description: >-
 184           Indicates whether the requested additional capability is mandatory for successful
 185           operation.
 186         type: string
 187         required: true
 188       min_requested_additional_capability_version:
 189         description: >-
 190           Identifies the minimum version of the requested additional capability.
 191         type: string
 192         required: false
 193       preferred_requested_additional_capability_version:
 194         description: >-
 195           Identifies the preferred version of the requested additional capability.
 196         type: string
 197         required: false
 198       target_performance_parameters:
 199         description: >-
 200           Identifies specific attributes, dependent on the requested additional capability type.
 201         type: map
 202         entry_schema:
 203           type: string
 204         required: true
 205
 206   tosca.datatypes.nfv.VirtualMemory:
 207     _extensions:
 208       shorthand_name: VirtualMemory
 209       type_qualified_name: tosca:VirtualMemory
 210       specification: tosca-simple-nfv-1.0
 211       specification_section: 5.3.7
 212       specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896061'
 213     description: >-
 214       VirtualMemory describes virtual memory for a particular VDU.
 215     derived_from: tosca.datatypes.Root
 216     properties:
 217       virtual_mem_size:
 218         description: Amount of virtual memory.
 219         type: scalar-unit.size
 220         required: true
 221       virtual_mem_oversubscription_policy:
 222         description: >-
 223           The memory core oversubscription policy in terms of virtual memory to physical memory on
 224           the platform. The cardinality can be 0 during the allocation request, if no particular
 225           value is requested.
 226         type: string
 227         required: false
 228       numa_enabled:
 229         description: >-
 230           It specifies the memory allocation to be cognisant of the relevant process/core
 231           allocation. The cardinality can be 0 during the allocation request, if no particular value
 232           is requested.
 233         type: boolean
 234         required: false
 235
 236   tosca.datatypes.nfv.VirtualCpu:
 237     _extensions:
 238       shorthand_name: VirtualCpu
 239       type_qualified_name: tosca:VirtualCpu
 240       specification: tosca-simple-nfv-1.0
 241       specification_section: 5.3.8
 242       specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896062'
 243     description: >-
 244       VirtualMemory describes virtual memory for a particular VDU.
 245     derived_from: tosca.datatypes.Root
 246     properties:
 247       cpu_architecture:
 248         description: >-
 249           CPU architecture type. Examples are x86, ARM.
 250         type: string
 251         required: false
 252       num_virtual_cpu:
 253         description: >-
 254           Number of virtual CPUs.
 255         type: integer
 256         required: true
 257       virtual_cpu_clock:
 258         description: >-
 259           Minimum virtual CPU clock rate.
 260         type: scalar-unit.frequency
 261         required: false
 262       virtual_cpu_oversubscription_policy:
 263         description: >-
 264           CPU core oversubscription policy.
 265         type: string
 266         required: false
 267       virtual_cpu_pinning:
 268         description: >-
 269           The virtual CPU pinning configuration for the virtualized compute resource.
 270         type: tosca.datatypes.nfv.VirtualCpuPinning
 271         required: false
 272
 273   tosca.datatypes.nfv.VirtualCpuPinning:
 274     _extensions:
 275       shorthand_name: VirtualCpuPinning
 276       type_qualified_name: tosca:VirtualCpuPinning
 277       specification: tosca-simple-nfv-1.0
 278       specification_section: 5.3.9
 279       specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896064'
 280     description: >-
 281       VirtualCpuPinning describes CPU pinning configuration for a particular CPU.
 282     derived_from: tosca.datatypes.Root
 283     properties:
 284       cpu_pinning_policy:
 285         description: >-
 286           Indicates the policy for CPU pinning.
 287         type: string
 288         constraints:
 289           - valid_values: [ static, dynamic ]
 290         required: false
 291       cpu_pinning_map:
 292         description: >-
 293           If cpuPinningPolicy is defined as "static", the cpuPinningMap provides the map of pinning
 294           virtual CPU cores to physical CPU cores/threads.
 295         type: map
 296         entry_schema:
 297           type: string
 298         required: false
 299
 300   tosca.datatypes.nfv.VnfcConfigurableProperties:
 301     _extensions:
 302       shorthand_name: VnfcconfigurableProperties
 303       type_qualified_name: tosca:VnfcconfigurableProperties
 304       specification: tosca-simple-nfv-1.0
 305       specification_section: 5.3.10
 306       specification_url: 'http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd04/tosca-nfv-v1.0-csd04.html#_Toc482896065'
 307     # ARIA NOTE: description is mangled in spec
 308     description: >-
 309       VnfcConfigurableProperties describes additional configurable properties of a VNFC.
 310     derived_from: tosca.datatypes.Root
 311     properties:
 312       additional_vnfc_configurable_properties:
 313         description: >-
 314           Describes additional configuration for VNFC.
 315         type: map
 316         entry_schema:
 317           type: string
 318         required: false