#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

tosca_definitions_version: tosca_simple_yaml_1_1

metadata:
  filename: onap/data.yml
  version: '1.0'

imports:
- onap_index:
    file: _index.yml

data_types:

  tosca.datatypes.nfv.RequestedAdditionalCapability:
    derived_from: tosca.datatypes.Root
    properties:
      support_mandatory:
        type: boolean
        required: true
      min_requested_additional_capability_version:
        type: string
        required: false
      preferred_requested_additional_capability_version:
        type: string
        required: false
      requested_additional_capability_name:
        type: string
        required: true
      target_performance_parameters:
        type: map
        entry_schema:
          type: string
        required: true
  tosca.datatypes.nfv.VirtualMemory:
    derived_from: tosca.datatypes.Root
    properties:
      virtual_mem_size:
        type: scalar-unit.size
        required: true
      virtual_mem_oversubscription_policy:
        type: string
        required: false
      vdu_memory_requirements:
        type: map
        entry_schema:
          type: string
        required: false
      numa_enabled:
        type: boolean
        required: false
  tosca.datatypes.nfv.VirtualCpu:
    derived_from: tosca.datatypes.Root
    properties:
      cpu_architecture:
        type: string
        required: false
      num_virtual_cpu:
        type: integer
        required: true
      virtual_cpu_clock:
        type: scalar-unit.frequency
        required: false
      virtual_cpu_oversubscription_policy:
        type: string
        required: false
      vdu_cpu_requirements:
        type: map
        entry_schema:
          type: string
        required: false
      virtual_cpu_pinning:
        type: tosca.datatypes.nfv.VirtualCpuPinning
        required: false
  tosca.datatypes.nfv.LogicalNodeData:
    derived_from: tosca.datatypes.Root
    properties:
      logical_node_requirements:
        type: map # not defined in SOL001 v.6.0
        entry_schema:
          type: string
        required: false
  tosca.datatypes.nfv.VirtualCpuPinning:
    derived_from: tosca.datatypes.Root
    properties:
      cpu_pinning_policy:
        type: string
        constraints:
          - valid_values: [ static, dynamic ]
        required: false
      cpu_pinning_map:
        type: map
        entry_schema:
          type: string
        required: false
  tosca.datatypes.nfv.VnfcConfigurableProperties:
    derived_from: tosca.datatypes.Root
    properties:
      additional_vnfc_configurable_properties:
        entry_schema:
          type: string
        required: false
        type: map
  tosca.datatypes.nfv.L3AddressData:
    derived_from: tosca.datatypes.Root
    properties:
      ip_address_assignment:
        type: boolean
        required: true
      floating_ip_activated:
        type: boolean
        required: true
      ip_address_type:
        type: string
        required: false
        constraints:
          - valid_values: [ipv4, ipv6]
      number_of_ip_address:
        type: integer
        required: false
      fixed_ip_address: #used for vCPE usecase
        type: list
        entry_schema:
          type: string
        required: false
  tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements:
    derived_from: tosca.datatypes.Root
    properties:
      name:
        type: string
        required: false
      description:
        type: string
        required: false
      support_mandatory:
        type: boolean
        required: true
      network_interface_requirements:
        type: map
        entry_schema:
          type: string
        required: true
      nic_io_requirements:
        type: tosca.datatypes.nfv.LogicalNodeData
        required: false
  tosca.datatypes.nfv.injectFile: #used for vCPE usecase
    derived_from: tosca.datatypes.Root
    properties:
      source_path:
        type: string
        required: true
      dest_path:
        type: string
        required: true
  tosca.datatype.nfv.AddressData:
    derived_from: tosca.datatypes.Root
    properties:
      address_type:
        constraints:
        - valid_values: [mac_address, ip_address]
        type: string
        required: true
      l2_address_data:
        required: false
        type: tosca.datatypes.nfv.L2AddressData
      l3_address_data:
        required: false
        type: tosca.datatypes.nfv.L3AddressData
  tosca.datatypes.nfv.L2AddressData:
    derived_from: tosca.datatypes.Root
    properties:
      mac_address_assignment:
        type: boolean
        required: true
  tosca.datatypes.nfv.ConnectivityType:
    derived_from: tosca.datatypes.Root
    properties:
      layer_protocol:
        constraints:
          - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ]
        type: string
        required: true
      flow_pattern:
        required: false
        type: string
        # not defined in IFA011 v2.4.1 and SOL001 v.6.0
        constraints:
        - valid_values: [Line, Tree, Mesh]
  tosca.datatypes.nfv.ext.FloatingIP:
    properties:
      external_network:
        required: false
        type: string
      ip_address:
        required: false
        type: string
  tosca.datatypes.nfv.ext.AddressPairs:
    properties:
      ip:
        required: false
        type: string
      mac:
        required: false
        type: string
  tosca.datatypes.nfv.ext.InjectData:
    properties:
      file_name:
        required: false
        type: string
      file_data:
        required: false
        type: string
  tosca.datatypes.nfv.ext.zte.WatchDog:
    properties:
      enable_delay:
        required: false
        type: integer
      action:
        required: false
        type: string
  tosca.datatypes.nfv.ext.LocalAffinityOrAntiAffinityRule:
    properties:
      scope:
        required: false
        type: string
      affinity_antiaffinity:
        required: false
        type: string
  tosca.datatypes.nfv.ext.LocationInfo:
    properties:
      availability_zone:
        required: false
        type: string
      vimid:
        required: false
        type: integer
      tenant:
        required: false
        type: string
  tosca.datatypes.nfv.ext.HostRouteInfo:
    properties:
      destination:
        required: false
        type: string
      nexthop:
        required: false
        type: string
  tosca.datatypes.nfv.VduProfile:
    derived_from: tosca.datatypes.Root
    properties:
      min_number_of_instances:
        type: integer
        required: true
      max_number_of_instances:
        type: integer
        required: true
      #localAffinityOrAntiAffinityRule:  # not defined in SOL001 v.6.0
      #  type: tosca.datatypes.nfv.LocalAffinityOrAntiAffinityRule
      #  required: true
      #affinityOrAntiAffinityGroupId: # not defined in SOL001 v.6.0
      #  type: string
      #  required: true
      watchdog: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: string
        required: true
      vmBootUpTimeOut: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: integer
        required: false
  tosca.datatypes.nfv.LinkBitRateRequirements:
    derived_from: tosca.datatypes.Root
    properties:
      root:
        type: integer
        required: true
      leaf:
        type: integer
        required: true
  tosca.datatypes.nfv.Qos:
    derived_from: tosca.datatypes.Root
    properties:
      latency:
        type: integer #Number [ms]
        required: true
      packet_delay_variation:
        type: integer #Number [ms]
        required: true
      packet_loss_ratio:
        type: float #Number [0 ..1]
        constraints:
          - in_range: [ 0.0, 1.0 ]
        required: false
  tosca.datatypes.nfv.VlProfile:
    derived_from: tosca.datatypes.Root
    properties:
      max_bit_rate_requirements:
        type: tosca.datatypes.nfv.LinkBitRateRequirements
        required: true
      min_bit_rate_requirements:
        type: tosca.datatypes.nfv.LinkBitRateRequirements
        required: true
      qos:
        type: tosca.datatypes.nfv.Qos
        required: false
      initiationParameters: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: map
        entry_schema:
          type: string
        required: false
      cidr: #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: string
        required: false
      networkName:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: string
        required: false
      startIp:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: string
        required: false
      endIp:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: string
        required: false
      gatewayIp:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: string
        required: false
      segmentationId:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: integer
        required: false
      physicalNetwork:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: string
        required: false
      networkType:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: string
        required: false
        constraints:
          - valid_values: [VLAN, VXLAN]
      dhcpEnabled:  # not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: boolean
        required: false
      vlanTransparent:  #Align with ONAP R2 IM. not defined in IFA011 v2.4.1 and SOL001 v.6.0
        type: boolean
        required: false
  tosca.datatypes.nfv.VduLevel:
    derived_from: tosca.datatypes.Root
    properties:
      number_of_instances:
        type: integer
        required: true
  tosca.datatypes.nfv.ScaleInfo:
    derived_from: tosca.datatypes.Root
    properties:
      scaleLevel:
        type: integer
        required: true
  tosca.datatypes.nfv.ScaleAspect:
    derived_from: tosca.datatypes.Root
    properties:
      name:
        type: string
        required: true
      description:
        type: string
        required: true
      associated_group:
        type: string #Identifier
        required: false
      max_scale_level:
        type: integer #PositiveInteger
        required: true
  tosca.datatypes.nfv.InstantiationLevel:
    derived_from: tosca.datatypes.Root
    properties:
      description:
        type: string
        required: true
      vdu_levels:
        type: map # key: vduId
        required: true
        entry_schema:
          type: tosca.datatypes.nfv.VduLevel
      scale_info:
        type: map # key: aspectId
        required: false
        entry_schema:
          type: tosca.datatypes.nfv.ScaleInfo
  tosca.datatypes.nfv.VnfInstantiateOperationConfiguration:
    derived_from: tosca.datatypes.Root
    properties:
      description:
        type: string
        required: false
      #parameters:
         #modeled as part of operation parameter list
  tosca.datatypes.nfv.VnfScaleOperationConfiguration:
    derived_from: tosca.datatypes.Root
    properties:
      #parameters:
         #modeled as part of the operation parameter list
      scaling_by_more_than_one_step_supported:
        type: boolean
  tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration:
    derived_from: tosca.datatypes.Root
    properties:
      #parameters:
        #modeled as part of the operation parameter list
      arbitrary_target_levels_supported:
        type: boolean
  tosca.datatypes.nfv.VnfHealOperationConfiguration:
    derived_from: tosca.datatypes.Root
    properties:
      #parameters:
         #modeled as part of the operation parameter list
      causes:
        type: list
        entry_schema:
          type: string
  tosca.datatypes.nfv.VnfTerminateOperationConfiguration:
    derived_from: tosca.datatypes.Root
    properties:
      min_graceful_termination_timeout:
        type: integer
      max_recommended_graceful_termination_timeout:
        type: integer
  tosca.datatypes.nfv.VnfOperateOperationConfiguration:
    derived_from: tosca.datatypes.Root
    properties:
      min_graceful_termination_timeout:
        type: integer
      max_recommended_graceful_termination_timeout:
        type: integer
  tosca.datatypes.nfv.VnfLcmOperationsConfiguration:
    derived_from: tosca.datatypes.Root
    properties:
      instantiate:
        type: tosca.datatypes.nfv.VnfInstantiateOperationConfiguration
      scale:
        type: tosca.datatypes.nfv.VnfScaleOperationConfiguration
      scale_to_level:
        type: tosca.datatypes.nfv.VnfScaleToLevelOperationConfiguration
      heal:
        type: tosca.datatypes.nfv.VnfHealOperationConfiguration
      terminate:
        type: tosca.datatypes.nfv.VnfTerminateOperationConfiguration
      operate:
        type: tosca.datatypes.nfv.VnfOperateOperationConfiguration
  tosca.datatypes.nfv.CpProtocolData:
    derived_from: tosca.datatypes.Root
    properties:
      asscociated_layer_protocol:
        type: string
        constraints:
          - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ]
        required: true
      address_data:
        type: tosca.datatypes.nfv.AddressData
        required: false
  tosca.datatypes.nfv.VnfAdditionalConfigurableProperties:
    derived_from: tosca.datatypes.Root
    properties:
      description:
        type: string
        required: false
  tosca.datatypes.nfv.VnfConfigurableProperties:
    derived_from: tosca.datatypes.Root
    properties:
      is_autoscale_enabled:
        type: boolean
        required: false
      is_autoheal_enabled:
        type: boolean
        required: false
      additional_configurable_properties:
        type: tosca.datatypes.nfv.VnfAdditionalConfigurableProperties
        required: false
  tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions:
    derived_from: tosca.datatypes.Root
    properties:
      description:
        type: string
        required: false
  tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata:
    derived_from: tosca.datatypes.Root
    properties:
      description:
        type: string
        required: false
  tosca.datatypes.nfv.VnfInfoModifiableAttributes:
    derived_from: tosca.datatypes.Root
    properties:
      extensions:
        type: tosca.datatypes.nfv.VnfInfoModifiableAttributesExtensions
        required: false
      metadata:
        type: tosca.datatypes.nfv.VnfInfoModifiableAttributesMetadata
        required: false