---
metadata:
  version: "1.0"
schemas:
  # schema name
  vduCpuRequirements:
      # hpa key name
      cpuModelSpecificationBinding:
        # json encoded key name: reg expression for the valid value
        schemaVersion: &any '.*'
        schemaSelector: *any
        hardwarePlatform: &generic 'generic'
        mandatory: &bool 'true|false|TRUE|FALSE|True|False'
        configurationValue: '^(strictBinding|equalOrBetterBinding)$'
      instructionSetRequirements:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      simultaneousMultiThreading:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: '^(enabled|disabled)$'
      hypervisorConfiguration:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      computeRas:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: '^(pciDetectedAndCorrectedErrors|pciDetectedAndUncorrectedErrors)$'
      cpuModel:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      directIoAccessToCache:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      accelerator:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      measuredLaunchEnvironment:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      secureEnclave:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      numVirtualCpu:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: &pos_int '^\d+$'
      virtualCpuClock:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: '^\d+\s*(Hz|kHz|MHz|GHz)$'
      logicalCpuPinningPolicy:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: '^(dedicated|shared)$'
      logicalCpuThreadPinningPolicy:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: '^(require|isolate|prefer)$'
  vduMemRequirements:
      memoryPageSize:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: &mem_size '^\d+\s*(B|kB|KB|KiB|MB|MiB|GB|GiB|TB|TiB)$'
      numberOfPages:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *pos_int
      memoryAllocationPolicy:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: '^(strictLocalAffinity|preferredLocalAffinity)$'
      memoryType:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      memorySpeed:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      memoryRas:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      memoryBandwidth:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *pos_int
      processorCacheAllocationType:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      processorCacheAllocationSize:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
  vduStorageRequirements:
      storageIops:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *pos_int
      storageResilencyMechanism:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: '^(erasure|tripleReplication)$'
      processorCacheAllocationSize:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      processorCacheAllocationSize:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
  logicalNodeComputeMemoryRequirements:
      numberCpu:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *pos_int
      localNumaMemorySize:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *mem_size
  logicalNodeIoRequirements:
      pciVendorId:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      pciDeviceId:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      pciNumDevices:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *pos_int
      pciAddress:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      pciDeviceLocalToNumaNode:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: '^(required|notRequired)$'
  networkInterfaceRequirements:
      nicFeature:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      dataProcessingAccelerationLibrary:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: '^(DPDK|dpdk)$'
      dataProcessingAccelerationLibraryVersion:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: *any
      interfaceType:
        schemaVersion: *any
        schemaSelector: *any
        hardwarePlatform: *generic
        mandatory: *bool
        configurationValue: '^(virtio|PCI-Passthrough|SR-IOV|E1000|RTL8139|PCNET)$'
mappings:
# mapping between property value of a tosca node type and the valid hpa schema
#   type: tosca node type
#   key: prop1##prop2##...##propN
#          Property hierachy within that node type. Prefix of '(capability:)'
#          in propI means the value is from capability instead of property.
#   schema: schema defined in the above schemas section
  - type: tosca.nodes.nfv.Vdu.Compute
    key: capability:virtual_compute##logical_node##logical_node_requirements
    schema: logicalNodeComputeMemoryRequirements
  - type: tosca.nodes.nfv.Vdu.Compute
    key: capability:virtual_compute##virtual_cpu##vdu_cpu_requirements
    schema: vduCpuRequirements
  - type: tosca.nodes.nfv.Vdu.Compute
    key: capability:virtual_compute##virtual_memory##vdu_memory_requirements
    schema: vduMemRequirements
  - type: tosca.nodes.nfv.Vdu.VirtualStorage
    key: vdu_storage_requirements
    schema: vduStorageRequirements
  - type: tosca.nodes.nfv.VduCp
    key: virtual_network_interface_requirements##network_interface_requirements
    schema: networkInterfaceRequirements
  - type: tosca.nodes.nfv.VduCp
    key: virtual_network_interface_requirements##nic_io_requirements##logical_node_requirements
    schema: logicalNodeIoRequirements