Page Comparison

All infrastructure capability types inherit from the basic The ONAP Data Model reflects the IM's ComputeDesc and MemoryDesc elements as the TOSCA capability type onap.capabilities.Compute.Infrastructure:

Code Block

title	Basic infrastructure capability type
linenumbers	true

capability_types:
  onap.capabilities.InfrastractureCompute:
    derived_from: tosca.capabilities.RootContainer
    description: a basic description of the required infrastructurehardware resources
    properties:
      architecturenum_cpus:
 
      description: vendor+architecture, for example, Intel64
        type: stringinteger
        required: false
         
      custom_features:
        description: |
    constraints:
     Additional features description, serialized in a well-known format.
        type: string
        required: false

Since all HPA-oriented capability types are derived from this basic type, they will all inherit its properties:

architecture - allows the VFC vendors to focus their requirements on a specific hardware architecture, for example "Intel x86".
custom_features - an opaque container for a list of feature definitions. Any text, the only limitation is that it should not break the YAML/TOSCA formatting. The contents of this property is actually not part of the TOSCA model!

Based on this generic onap,capabilities.Infrastructure capability type, the Data Model introduces a family of types that provide TOSCA support for the Informational Model elements.

Code Block

title	onap.capabilities.infrastructure.CPU
linenumbers	true
collapse	true

capability_types:
  onap.capabilities.infrastructure.CPU: greater_or_equal: 1
      derived_from: onap.capabilities.Infrastracture
    description: processor capabilities
    propertiescpu_frequency:
      num_cpus:         type: integerscalar-unit.frequency
        required: false
        constraints:
          - greater_or_equal: 0.1 GHz
      cpumem_frequencysize:
        type: scalar-unit.frequencysize
        required: false
        constraints:
          - greater_or_equal: 0.1 GHz

Code Block

title	onap.capabilities.infrastructure.Memory
linenumbers	true
collapse	true

capability_types:
  onap.capabilities.infrastructure.Memory:
    derived_from: onap.capabilities.Infrastracture MB
    description: memory capabilities
    properties:
      mem storage_size:
        type: scalar-unit.size
        required: false
        constraints:
          - greater_or_equal: 0 MB

Code Block

title	onap.capabilities.infrastructure.Storage
linenumbers	true
collapse	true

capability_types:
  onap.capabilities.infrastructure.Storage:     derivedio_frombitrate:
onap.capabilities.Infrastracture     description: storage specifications     propertiesdescription: bits      storage_size:per second
        type: scalar-unit.sizeinteger
        required: false
        constraintsarchitecture:
          - greater_or_equaldescription: 0 MB

Code Block

title	onap.capabilities.infrastructure.IO
linenumbers	true
collapse	true

capability_types:
  onap.capabilities.infrastructure.IO:vendor+architecture, for example, Intel64
    derived_from: onap.capabilities.Infrastracture     descriptiontype: basicstring
IO specifications       bitraterequired: false        description: bits per
second         typecustom_features:
integer         requireddescription: false

Code Block

title	onap.capabilities.infrastructure.NIC
linenumbers	true
collapse	true

capability_types:|
        onap.capabilities.infrastructure.NIC:  Additional features  derived_from: onap.capabilities.Infrastracture
    description: basic IO specificationsdescription, serialized in a well-known format.
        type: bitrate:string
        descriptionrequired: bitsfalse per second        
type: integer
        required: false

In addtition to the obvious properties required by the IM, this capability type also includes properties that allow for easy customization:

architecture - allows the VFC vendors to focus their requirements on a specific hardware architecture, for example "Intel x86".
custom_features - an opaque container for a list of feature definitions. Any text, the only limitation is that it should not break the YAML/TOSCA formatting. The contents of this property is actually not part of the TOSCA model!

In spite the changes made in the capability type defininitions, the definition of the node type onap.nodes.Container does not change:

Code Block

title	onap.nodes.Container
linenumbers	true
collapse	true

node_types:
  # the very base of the hierarchy of VDU types
  onap.nodes.Container:
    derived_from: onap.nodes.Resource
    artifacts:
      container_image:
        type: tosca.artifacts.Deployment
        description: an image used to launch the Container
    interfaces:
      Standard:
        start:
          implementation: container_image
    capabilities:
      host:
        type: tosca.capabilities.Container  # the TOSCA Specs type is good enough
        occurrences: [0..UNBOUNDED]
    requirements:
      - cpuhost:
          capability: onap.capabilities.infrastructure.CPU:
          occurrences: [0..1]
      - memory:
          capability: onap.capabilities.infrastructure.Memory:
          occurrences: [0..UNBOUNDED]
      - storage:
          capability: onap.capabilities.infrastructure.Storage:
          occurrences: [0..UNBOUNDED]Compute:
       - io:
          capability: onap.capabilities.infrastructure.IO:
          occurrences: [0..UNBOUNDED]
    
 - nic:
          capability: onap.capabilities.infrastructure.NIC:
          occurrences: [0..UNBOUNDED]

Examples of requirement assignments in their simplest form:

Code Block

title	Requirement for at least 2 vCPUs
linenumbers	true
collapse	true

# .. a node template, omitted...
requirements:
  - cpuhost:
      node_filter:
        capabilities: onap.capabilities.infrastructure.CPUCompute
        properties:
          num_cpus:
            - greater_or_equal: 2

Examples of requirement assignments in the combined (TOSCA properties + custom_features) form:

Code Block

title	Requirement for at least 2 vCPUs + bunch of Intel-specific features
linenumbers	true
collapse	true

# .. a node template, omitted...
requirements:
  - cpuhost:
      node_filter:
        capabilities: onap.capabilities.infrastructure.CPUCompute
        properties:
          num_cpus:
            - greater_or_equal: 2
          custom_features: |
            {
              "simultaneousMultiThreading": true,
              "simultaneousThreads": 10,
              "logicalCpuPinningPolicy": "Dedicated",
              "logicalCpuThreadPinningPolicy": "Prefer",
              "instructionSetExtensions": ["aes", "sse", "ddio"],
              "directIoAccessToCache": "dca",
              "accelerator": "whatever you like",
              "measuredLaunchEnvironment": "",
              "secureEnclave": "",
              "hypervisorConfiguration": {
                "memoryCompaction": "best",
                "kernelSamePageMerging": true
              },
              "computeRas": "pciDetectedAndCorrectedErrors"
            }

In the example above the text in the custom_features property is actually a JSON document.

The hardware vendors are encouraged to provide a well-defined schema (JSON Schema for JSON-formatted texts, DTD or XML Schema for XML-formatted texts, etc) to govern syntax of their custom_feature texts. For example, a JSON schema for the CPU custom feature fron the example above may look like this:

Code Block

language	js
title	Example of JSON Schema for CPU custom features
linenumbers	true
collapse	true

{
  "definitions": {
	"hypervisorConfiguration": {
		"type": "object",
		"properties": {
			"memoryCompaction": { "enum": [ "best", "worst", "optimal" ] },
			"kernelSamePageMerging": {"type": "boolean" }
		}
	}
  },
  
  "type": "object",
  
  "properties": {
	"simultaneousMultiThreading": {"type": "boolean"},
	"simultaneousThreads": {"type": "integer", "minimum": 1, "maximum": 4},
	"logicalCpuPinningPolicy": {"type": "string" },
    "hypervisorConfiguration": { "$ref": "#/definitions/hypervisorConfiguration" },
	"instructionSetExtensions": {
		"type": "array", 
		"items": {
			"type": "string",
			"enum": [ "aes", "sse", "avx", "cat", "cmt", "mbm", "ddio", "smt", "rdrand" ]
		}
	}
  }
}

The idea of using a schema document together with the custom_features text seems to be very powerful. For a demostration of how such a schema would work, please visit any of the JSON schema validators available online, for example, https://json-schema-validator.herokuapp.com/. Just copy and paste over there the above JSON schema and the value of the custom_feature field and check on the validation results:

Image Added

TOSCA 1.2 allows using a JSON schema as a TOSCA constraint in parameter definition and node_filter clauses. Using an external schema document (with a Web URL in the TOSCA constraint clause) seems to be especially promising, since such usage combines the benefits of schema-driven validation with the flexibility of having the schema hosted outside:

Code Block

title	External JSON schema in a TOSCA requirement assignment
linenumbers	true
collapse	true

requirements:
  - host:
      node_filter:
        capabilities: onap.capabilities.infrastructure.CPU
        properties:
          num_cpus:
            - greater_or_equal: 2
          custom_features: 
            - schema: http://my.domain.com/url/datatype.constraints.schema.json

Versions Compared

Old Version 7

New Version Current

Key