common/onap-tosca-datatype/src/main/resources/globalTypes/onap/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: onap/data.yml
  19   version: '1.0'
  20
  21 imports:
  22 - onap_index:
  23     file: _index.yml
  24
  25 data_types:
  26
  27   tosca.datatypes.nfv.RequestedAdditionalCapability:
  28     derived_from: tosca.datatypes.Root
  29     properties:
  30       support_mandatory:
  31         type: boolean
  32         required: true
  33       min_requested_additional_capability_version:
  34         type: string
  35         required: false
  36       preferred_requested_additional_capability_version:
  37         type: string
  38         required: false
  39       requested_additional_capability_name:
  40         type: string
  41         required: true
  42       target_performance_parameters:
  43         type: map
  44         entry_schema:
  45           type: string
  46         required: true
  47   tosca.datatypes.nfv.VirtualMemory:
  48     derived_from: tosca.datatypes.Root
  49     properties:
  50       virtual_mem_size:
  51         type: scalar-unit.size
  52         required: true
  53       virtual_mem_oversubscription_policy:
  54         type: string
  55         required: false
  56       vdu_memory_requirements:
  57         type: map
  58         entry_schema:
  59           type: string
  60         required: false
  61       numa_enabled:
  62         type: boolean
  63         required: false
  64   tosca.datatypes.nfv.VirtualCpu:
  65     derived_from: tosca.datatypes.Root
  66     properties:
  67       cpu_architecture:
  68         type: string
  69         required: false
  70       num_virtual_cpu:
  71         type: integer
  72         required: true
  73       virtual_cpu_clock:
  74         type: scalar-unit.frequency
  75         required: false
  76       virtual_cpu_oversubscription_policy:
  77         type: string
  78         required: false
  79       vdu_cpu_requirements:
  80         type: map
  81         entry_schema:
  82           type: string
  83         required: false
  84       virtual_cpu_pinning:
  85         type: tosca.datatypes.nfv.VirtualCpuPinning
  86         required: false
  87   tosca.datatypes.nfv.LogicalNodeData:
  88     derived_from: tosca.datatypes.Root
  89     properties:
  90       logical_node_requirements:
  91         type: map # not defined in SOL001 v.6.0
  92         entry_schema:
  93           type: string
  94         required: false
  95   tosca.datatypes.nfv.VirtualCpuPinning:
  96     derived_from: tosca.datatypes.Root
  97     properties:
  98       cpu_pinning_policy:
  99         type: string
 100         constraints:
 101           - valid_values: [ static, dynamic ]
 102         required: false
 103       cpu_pinning_map:
 104         type: map
 105         entry_schema:
 106           type: string
 107         required: false
 108   tosca.datatypes.nfv.VnfcConfigurableProperties:
 109     derived_from: tosca.datatypes.Root
 110     properties:
 111       additional_vnfc_configurable_properties:
 112         entry_schema:
 113           type: string
 114         required: false
 115         type: map
 116   tosca.datatypes.nfv.L3AddressData:
 117     derived_from: tosca.datatypes.Root
 118     properties:
 119       ip_address_assignment:
 120         type: boolean
 121         required: true
 122       floating_ip_activated:
 123         type: boolean
 124         required: true
 125       ip_address_type:
 126         type: string
 127         required: false
 128         constraints:
 129           - valid_values: [ipv4, ipv6]
 130       number_of_ip_address:
 131         type: integer
 132         required: false
 133       fixed_ip_address: #used for vCPE usecase
 134         type: list
 135         entry_schema:
 136           type: string
 137         required: false
 138   tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
 139     derived_from: tosca.datatypes.Root
 140     properties:
 141       name:
 142         type: string
 143         required: false
 144       description:
 145         type: string
 146         required: false
 147       support_mandatory:
 148         type: boolean
 149         required: true
 150       network_interface_requirements:
 151         type: map
 152         entry_schema:
 153           type: string
 154         required: true
 155       nic_io_requirements:
 156         type: tosca.datatypes.nfv.LogicalNodeData
 157         required: false
 158   tosca.datatypes.nfv.injectFile: #used for vCPE usecase
 159     derived_from: tosca.datatypes.Root
 160     properties:
 161       source_path:
 162         type: string
 163         required: true
 164       dest_path:
 165         type: string
 166         required: true
 167   tosca.datatype.nfv.AddressData:
 168     derived_from: tosca.datatypes.Root
 169     properties:
 170       address_type:
 171         constraints:
 172         - valid_values: [mac_address, ip_address]
 173         type: string
 174         required: true
 175       l2_address_data:
 176         required: false
 177         type: tosca.datatypes.nfv.L2AddressData
 178       l3_address_data:
 179         required: false
 180         type: tosca.datatypes.nfv.L3AddressData
 181   tosca.datatypes.nfv.L2AddressData:
 182     derived_from: tosca.datatypes.Root
 183     properties:
 184       mac_address_assignment:
 185         type: boolean
 186         required: true
 187   tosca.datatypes.nfv.ConnectivityType:
 188     derived_from: tosca.datatypes.Root
 189     properties:
 190       layer_protocol:
 191         constraints:
 192           - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ]
 193         type: string
 194         required: true
 195       flow_pattern:
 196         required: false
 197         type: string
 198         # not defined in IFA011 v2.4.1 and SOL001 v.6.0
 199         constraints:
 200         - valid_values: [Line, Tree, Mesh]
 201   tosca.datatypes.nfv.ext.FloatingIP:
 202     properties:
 203       external_network:
 204         required: false
 205         type: string
 206       ip_address:
 207         required: false
 208         type: string
 209   tosca.datatypes.nfv.ext.AddressPairs:
 210     properties:
 211       ip:
 212         required: false
 213         type: string
 214       mac:
 215         required: false
 216         type: string
 217   tosca.datatypes.nfv.ext.InjectData:
 218     properties:
 219       file_name:
 220         required: false
 221         type: string
 222       file_data:
 223         required: false
 224         type: string
 225   tosca.datatypes.nfv.ext.zte.WatchDog:
 226     properties:
 227       enable_delay:
 228         required: false
 229         type: integer
 230       action:
 231         required: false
 232         type: string
 233   tosca.datatypes.nfv.ext.LocalAffinityOrAntiAffinityRule:
 234     properties:
 235       scope:
 236         required: false
 237         type: string
 238       affinity_antiaffinity:
 239         required: false
 240         type: string
 241   tosca.datatypes.nfv.ext.LocationInfo:
 242     properties:
 243       availability_zone:
 244         required: false
 245         type: string
 246       vimid:
 247         required: false
 248         type: integer
 249       tenant:
 250         required: false
 251         type: string
 252   tosca.datatypes.nfv.ext.HostRouteInfo:
 253     properties:
 254       destination:
 255         required: false
 256         type: string
 257       nexthop:
 258         required: false
 259         type: string
 260   tosca.datatypes.nfv.VduProfile:
 261     derived_from: tosca.datatypes.Root
 262     properties:
 263       min_number_of_instances:
 264         type: integer
 265         required: true
 266       max_number_of_instances:
 267         type: integer
 268         required: true
 269       #localAffinityOrAntiAffinityRule:  # not defined in SOL001 v.6.0
 270       #  type: tosca.datatypes.nfv.LocalAffinityOrAntiAffinityRule
 271       #  required: true
 272       #affinityOrAntiAffinityGroupId: # not defined in SOL001 v.6.0
 273       #  type: string
 274       #  required: true
 275       watchdog: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 276         type: string
 277         required: true
 278       vmBootUpTimeOut: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 279         type: integer
 280         required: false
 281   tosca.datatypes.nfv.LinkBitRateRequirements:
 282     derived_from: tosca.datatypes.Root
 283     properties:
 284       root:
 285         type: integer
 286         required: true
 287       leaf:
 288         type: integer
 289         required: true
 290   tosca.datatypes.nfv.Qos:
 291     derived_from: tosca.datatypes.Root
 292     properties:
 293       latency:
 294         type: integer #Number [ms]
 295         required: true
 296       packet_delay_variation:
 297         type: integer #Number [ms]
 298         required: true
 299       packet_loss_ratio:
 300         type: float #Number [0 ..1]
 301         constraints:
 302           - in_range: [ 0.0, 1.0 ]
 303         required: false
 304   tosca.datatypes.nfv.VlProfile:
 305     derived_from: tosca.datatypes.Root
 306     properties:
 307       max_bit_rate_requirements:
 308         type: tosca.datatypes.nfv.LinkBitRateRequirements
 309         required: true
 310       min_bit_rate_requirements:
 311         type: tosca.datatypes.nfv.LinkBitRateRequirements
 312         required: true
 313       qos:
 314         type: tosca.datatypes.nfv.Qos
 315         required: false
 316       initiationParameters: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 317         type: map
 318         entry_schema:
 319           type: string
 320         required: false
 321       cidr: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 322         type: string
 323         required: false
 324       networkName:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 325         type: string
 326         required: false
 327       startIp:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 328         type: string
 329         required: false
 330       endIp:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 331         type: string
 332         required: false
 333       gatewayIp:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 334         type: string
 335         required: false
 336       segmentationId:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 337         type: integer
 338         required: false
 339       physicalNetwork:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 340         type: string
 341         required: false
 342       networkType:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 343         type: string
 344         required: false
 345         constraints:
 346           - valid_values: [VLAN, VXLAN]
 347       dhcpEnabled:  # not defined in IFA011 v2.4.1 and SOL001 v.6.0
 348         type: boolean
 349         required: false
 350       vlanTransparent:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
 351         type: boolean
 352         required: false
 353   tosca.datatypes.nfv.VduLevel:
 354     derived_from: tosca.datatypes.Root
 355     properties:
 356       number_of_instances:
 357         type: integer
 358         required: true
 359   tosca.datatypes.nfv.ScaleInfo:
 360     derived_from: tosca.datatypes.Root
 361     properties:
 362       scaleLevel:
 363         type: integer
 364         required: true
 365   tosca.datatypes.nfv.ScaleAspect:
 366     derived_from: tosca.datatypes.Root
 367     properties:
 368       name:
 369         type: string
 370         required: true
 371       description:
 372         type: string
 373         required: true
 374       associated_group:
 375         type: string #Identifier
 376         required: false
 377       max_scale_level:
 378         type: integer #PositiveInteger
 379         required: true
 380   tosca.datatypes.nfv.InstantiationLevel:
 381     derived_from: tosca.datatypes.Root
 382     properties:
 383       description:
 384         type: string
 385         required: true
 386       vdu_levels:
 387         type: map # key: vduId
 388         required: true
 389         entry_schema:
 390           type: tosca.datatypes.nfv.VduLevel
 391       scale_info:
 392         type: map # key: aspectId
 393         required: false
 394         entry_schema:
 395           type: tosca.datatypes.nfv.ScaleInfo
 396   tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:
 397     derived_from: tosca.datatypes.Root
 398     properties:
 399       description:
 400         type: string
 401         required: false
 402       #parameters:
 403          #modeled as part of operation parameter list
 404   tosca.datatypes.nfv.VnfScaleOperationConfiguration:
 405     derived_from: tosca.datatypes.Root
 406     properties:
 407       #parameters:
 408          #modeled as part of the operation parameter list
 409       scaling_by_more_than_one_step_supported:
 410         type: boolean
 411   tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:
 412     derived_from: tosca.datatypes.Root
 413     properties:
 414       #parameters:
 415         #modeled as part of the operation parameter list
 416       arbitrary_target_levels_supported:
 417         type: boolean
 418   tosca.datatypes.nfv.VnfHealOperationConfiguration:
 419     derived_from: tosca.datatypes.Root
 420     properties:
 421       #parameters:
 422          #modeled as part of the operation parameter list
 423       causes:
 424         type: list
 425         entry_schema:
 426           type: string
 427   tosca.datatypes.nfv.VnfTerminateOperationConfiguration:
 428     derived_from: tosca.datatypes.Root
 429     properties:
 430       min_graceful_termination_timeout:
 431         type: integer
 432       max_recommended_graceful_termination_timeout:
 433         type: integer
 434   tosca.datatypes.nfv.VnfOperateOperationConfiguration:
 435     derived_from: tosca.datatypes.Root
 436     properties:
 437       min_graceful_termination_timeout:
 438         type: integer
 439       max_recommended_graceful_termination_timeout:
 440         type: integer
 441   tosca.datatypes.nfv.VnfLcmOperationsConfiguration:
 442     derived_from: tosca.datatypes.Root
 443     properties:
 444       instantiate:
 445         type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration
 446       scale:
 447         type: tosca.datatypes.nfv.VnfScaleOperationConfiguration
 448       scale_to_level:
 449         type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration
 450       heal:
 451         type: tosca.datatypes.nfv.VnfHealOperationConfiguration
 452       terminate:
 453         type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration
 454       operate:
 455         type: tosca.datatypes.nfv.VnfOperateOperationConfiguration
 456   tosca.datatypes.nfv.CpProtocolData:
 457     derived_from: tosca.datatypes.Root
 458     properties:
 459       asscociated_layer_protocol:
 460         type: string
 461         constraints:
 462           - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
 463         required: true
 464       address_data:
 465         type: tosca.datatypes.nfv.AddressData
 466         required: false
 467   tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:
 468     derived_from: tosca.datatypes.Root
 469     properties:
 470       description:
 471         type: string
 472         required: false
 473   tosca.datatypes.nfv.VnfConfigurableProperties:
 474     derived_from: tosca.datatypes.Root
 475     properties:
 476       is_autoscale_enabled:
 477         type: boolean
 478         required: false
 479       is_autoheal_enabled:
 480         type: boolean
 481         required: false
 482       additional_configurable_properties:
 483         type: tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
 484         required: false
 485   tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions:
 486     derived_from: tosca.datatypes.Root
 487     properties:
 488       description:
 489         type: string
 490         required: false
 491   tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata:
 492     derived_from: tosca.datatypes.Root
 493     properties:
 494       description:
 495         type: string
 496         required: false
 497   tosca.datatypes.nfv.VnfInfoModifiableAttributes:
 498     derived_from: tosca.datatypes.Root
 499     properties:
 500       extensions:
 501         type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
 502         required: false
 503       metadata:
 504         type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
 505         required: false