References

Some extra ONAP terminology

This terminology will be used through the mapping tables provided below.

Function

NFVs, VFCs, VDUs, and even Services are represented by the generic node type onap.nodes.Function.

Motivation:

  • To reflect and highlight the fact that from the orchestration perspective, all these classes are the same – TOSCA templates backed by artifacts
  • Making the model more lightweight, getting rid of redundant 
  • Allow for composition constructs more flexible than the basic ETSI VDU-VNF-Service cage. As a service provide, I may want to compose my own VNFs of other VNFs, Services that make use of other Services, etc.


Functions: Interface & Implementation

ONAP Data Model represents VNFs, VDUs, VFCs as the Interface Type combined with either the Implementation Topology or the Implementation Image

Interface Type

A VNF/VFC/VDU interface type is a TOSCA node type derived from onap.nodes.Function. For the sake of better readability, this node type may be have the metadata field ‘type’ and values [VNF, VDU, VFC]. The interface type defines properties, capabilities and requirements of the VNF/VFC/VDU.

Implementation Topology

An implementation topology of a VNF/VFC/VDU is a TOSCA topology template. It contains TOSCA node templates interconnected through TOSCA relationship/capability pairs or TOSCA relationship templates. The component node templates are normally of types derived from onap.nodes.CP, onap.nodes.VL, onap.nodes.Container, and onap.nodes.Function. An Implementation Topolgy must also include a TOSCA substitution_mappings construct that refers to an Interface Type and “wires” the properties, requirements and capabilities of the Interface Type to those of the internal nodes. In addition, the Implementation Topology may also include TOSCA groups and policies that target internal nodes.

Implementation Image

In its simplest form, a function does not have an Implementation Topology. Instead, its Interface Type specifies a TOSCA deployment artifact, like a VM or Docker image. This artifact is sufficient for the orchestrator to launch an instance of this function. This artifact is called an Implementation Artifact and effectively represents the SwImage element from the ONAP Info Model. A Function with an Implementation Image represents the VDU element of the Info Model.

VNFD information element


Attribute

Q

C

Content

Description

NFV

ONAP DM

Comparison





A VNFD is a deployment template which describes a VNF in terms of deployment and operational behaviour requirements. It also contains connectivity, interface and virtualised resource requirements.

  1. A TOSCA node type derived from tosca.nodes.nfv.vnfd (VNF interface type)
  2. A TOSCA topology template with substitution mapping to the VNF Interface Type #1 (VNF implementation template)


1)     A TOSCA node type derived from onap.node.Function (VNF interface type)

2)     A TOSCA topology template with substitution mapping to the VNF Interface Type #1 (VNF implementation template)


NFV: the node type is strictly bound to the VNFD element


ONAP DM: the node type is generic; the same node type is used to represent VNFs, VFCs, VDUs, and, in the future, Services. See Generic Node type onap.nodes.Function for all components

vnfdId

M

1

Identifier

Identifier of this VNFD information element. This attribute shall be globally unique. The format will be defined in the data model specification phase. See note 1.

Node type tosca.nodes.nfv.vnfd,

empty

Vendor-provided node type derived from onap.node.Function

Metadata fields:

UUID, invariantUUID


vnfProvider

M

1

String

Provider of the VNF and of the VNFD.


Node type onap.node.Function

Metadata fields:



vnfProductName

M

1

String

Name to identify the VNF Product.

Invariant for the VNF Product lifetime.


Node type onap.node.Function

Metadata fields:



vnfSoftwareVersion

M

1

Version

Software version of the VNF. This is changed when there is any change to the software that is included in the VNF Package.




vnfdVersion

M

1

Version

Identifies the version of the VNFD.


Node type onap.node.Function

Metadata fields:



vnfProductInfoName

M

0..1

String

Human readable name for the VNF Product. Can change during the VNF Product lifetime. 


Node type onap.node.Function

Metadata fields:



vnfProductInfo Description

M

0..1

String

Human readable description of the VNF Product. Can change during the VNF Product lifetime.


Node type onap.node.Function

Metadata fields:



vnfmInfo

M

1..N

String

Identifies VNFM(s) compatible with the

VNF described in this version of the VNFD.


CSAR Metadata (conformance level)

TODO: Add a new metadata field (conformance level)?


localizationLanguage

M

0..N

Not specified

Information about localization languages of the VNF (includes e.g. strings in the VNFD). See note 4.


Node type onap.node.Function

Metadata fields:



defaultLocalization Language

M

0..1

Not specified

Default localization language that is instantiated if no information about selected localization language is available. Shall be present if "localizationLanguage" is present and shall be absent otherwise.


Node type onap.node.Function

Metadata fields:



vdu

M

1..N

Vdu

Virtualisation Deployment Unit. See clause 7.1.6.


Node templates of onap.node.Function-derived types, contained in the VNF implementation topology.



virtualComputeDesc

M

0..N

VirtualCompute Desc

Defines descriptors of virtual compute resources to be used by the VNF. See clause 7.1.9.2.2.


TOSCA requirements of type onap.capabilities.Compute defined in the VNF Interface Type



virtualStorageDesc

M

0..N

VirtualStorage Desc

Defines descriptors of virtual storage resources to be used by the VNF. See clause 7.1.9.4.2.


TOSCA requirements of type onap.capabilities.Storage defined in  the VNF Interface Type



intVirtualLinkDesc

M

0..N

VnfVirtualLink Desc

Represents the type of network connectivity mandated by the VNF provider between two or more CPs which includes at least one internal CP. See clause 7.1.7.


Node templates of onap.node.VL-derived types, contained in the VNF implementation topology



vnfExtCpd

M

1..N

VnfExtCpd

Describes external interface(s) exposed by this VNF enabling connection with a VL.

See clause 7.1.3.


Requirements of type onap.capabilities.Linkable, defined in the Interface Type and mapped to the requirements of the same onap.capabilities.Linkable type of the internal nodes of either onap.nodes.CP or onap.nodes.Function types.


deploymentFlavour

M

1..N

VnfDf

Describes specific DF(s) of a VNF with specific requirements for capacity and performance. See clause 7.1.8.


Currently not supported


configurableProperties

M

0..1

VnfConfigurable Properties

Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing). See clause 7.1.12.


Everything related to scaling and healing is reflected as properties of the TOSCA policies contained by the Implementation Topology. All other configurableProperties are reflected by the TOSCA properties defined with the VNF Interface Type


modifiableAttributes

M

1

VnfInfoModifiable Attributes

Describes the modifiable attributes of the VNF. See clause 7.1.14.


Everything related to scaling and healing is reflected by the TOSCA policies contained by the Implementation Topology. All other modifiableAttributes are reflected by the TOSCA properties defined with the VNF Interface Type


lifeCycleManagementScript

M

0..N

LifeCycleManage mentScript

Includes a list of events and corresponding management scripts performed for the VNF. See clause 7.1.13.


TOSCA Lifecycle interface. All TOSCA node types have this interface, including onap.nodes.Function. This interface defines operations which reflect the Info Model events, and operation implementation artifacts which reflect the Info Model management script.


elementGroup

M

0..N

VnfdElementGro up

Describes the associated elements of a VNFD for a certain purpose during VNF lifecycle management. See clause 7.1.4.


TOSCA groups inside the Implementation Topology


vnfIndicator

M

0..N

VnfIndicator

Declares the VNF indicators that are supported by this VNF.


Currently not supported


autoScale

M

0..N

Rule

Rule that determines when a scaling action needs to be triggered on a VNF instance e.g. based on certain VNF indicator values or VNF indicator value changes or a combination of VNF indicator value(s) and monitoring parameter(s). See notes 2 and 3.


TOSCA scaling policies inside the Implementation Topology


NOTE 1: The VNFD Identifier shall be used as the unique identifier of the VNF Package that contains this VNFD. Any modification of the content of the VNFD or the VNF Package shall result in a new VNFD Identifier.

NOTE 2: Monitoring parameters are specified as part of VNF flavour, VDU and VL descriptions.

NOTE 3: The rule (conditions and actions) can be expressed as a script.

NOTE 4: This allows to provide one or more localization languages to support selecting a specific localization language at VNF instantiation time.






VnfExtCpd information element

Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM





A VnfExtCpd is a type of Cpd and describes an external interface, a.k.a external CP, exposed by this VNF enabling connection with a VL.

A VnfExtCpd inherits from the Cpd Class (see clause 7.1.6.3). All attributes of the Cpd are also attributes of the VnfExtCpd.

When the VnfExtCpd is mapped to a VduCpd, the values for the attributes type, subType and description shall be identical for both elements. 


No direct representation

A requirement of type onap.capabilities.Linkable, defined in the VNF Interface Type and mapped to the requirements of the same onap.capabilities.Linkable type of the internal nodes inside the VNF Implementation Topology which are of either onap.nodes.CP or onap.nodes.Function types.

intVirtualLinkDesc

M

0..1

Identifier (Reference to VnfVirtualLinkDesc)

Reference to the internal Virtual Link Descriptor (VLD) to which CPs instantiated from this external CP Descriptor (CPD) connect. Either intVirtualLinkDesc or intCpd shall be present.


Node templates of onap.node.VL-derived types, contained in the VNF implementation topology


intCpd

M

0..1

Identifier (Reference to VduCpd)

Reference to the internal VDU CPD which is used to instantiate internal CPs. These internal CPs are, in turn, exposed as external CPs defined by this external CPD. Either intVirtualLinkDesc or intCpd shall be present.


A requirement of type onap.capabilities.Linkable belonging to an internal onap.nodes.CP or onap.nodes.Function node inside the Implementing Topology. The Info Model link between the intCpd and the extCpd is implemented through the TOSCA substitution_mappings construct inside the VNF Implementation Topology. This mapping maps the Linkable requirement of the internal node to a requirement of the VNF Interface Type.

virtualNetworkInterfaceR equirements

M

0..N

VirtualNetworkInterface Requirements

Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD.

See note.


Properties of the onap.capabilities.Linkable capability type.

(inherited attributes)




All attributes inherited from Cpd.



NOTE:       In case of referencing an intCpd via its identifier, the virtualNetworkInterfaceRequirements attribute of the referenced intCpd applies.




AddressData information element

NFV: fully covered by the tosca.datatypes.nfv.AddressData data type

ONAP DM: Fully covered by the onap.datatypes.AddressData data type, which is a copy of tosca.datatypes.nfv.AddressData


L3AddressData information element

NFV: fully covered by the tosca.datatypes.nfv.L3AddressData data type

ONAP DM: Fully covered by the onap.datatypes.L3AddressData data type, which is a copy of tosca.datatypes.nfv.L3AddressData


VnfdElementGroup information element


Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM





A VNFD Element Group is a mechanism for associating elements of a VNFD (Vdus and VnfVirtualLinkDesc(s)) for a certain purpose, for example, scaling aspects.


No support so far

TOSCA groups inside the VNF Implementation Topology

vnfdElementGroupId

M

1

Identifier

Unique identifier of this group in the VNFD.


The TOSCA group name; the group customizationUUID metadata

description

M

1

String

Human readable description of the group.


The group description

vdu

M

0..N

Identifier (Reference to Vdu)

References to Vdus that are part of this group.


The group mentions as its members Function-typed nodes of the VNF Implementation Topology

virtualLinkDesc

M

0..N

Identifier (Reference to

VnfVirtualLinkDesc)

References to VnfVirtualLinkDesc that are part of this group.


The group mentions as its members VL-typed nodes of the VNF Implementation Topology


VnfLcmOperationsConfiguration information element


Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM

 

 

 

 

This clause defines information elements which represent information to configure lifecycle management operations as specified in ETSI GS NFV-IFA 007 [i.3].

 

Not supported

Supported in 2 ways:

  1. Through properties of TOSCA policies inside the VNF Implementation Topology
  2. Through input properties of the VNF Lifecycle interface

instantiateVnfOpConfig

M

0..1

InstantiateVnfOpConfig

Configuration parameters for the InstantiateVnf operation.

Not supported

TOSCA input properties specified with the create operation of the Lifecycle interface of the Function node type.

scaleVnfOpConfig

M

0..1

ScaleVnfOpConfig

Configuration parameters for the ScaleVnf operation.

Not supported

TOSCA properties on the TOSCA scaling policies inside the VNF Implementation Topology

scaleVnfToLevelOpConfig

M

0..1

ScaleVnfToLevelOpConfig

Configuration parameters for the ScaleVnfToLevel operation.

Not supported

TOSCA properties on the TOSCA scaling policies inside the VNF Implementation Topology

changeVnfFlavourOpConfig

M

0..1

ChangeVnfFlavourOpConf ig

Configuration parameters for the ChangeVnfFlavour operation.

Not supported

Not supported

healVnfOpConfig

M

0..1

HealVnfOpConfig

Configuration parameters for the HealVnf operation.

Not supported

TOSCA properties on the TOSCA scaling policies inside the VNF Implementation Topology

terminateVnfOpConfig

M

0..1

TerminateVnfOpConfig

Configuration parameters for the TerminateVnf operation.

Not supported

TOSCA input properties specified with the detete operation of the Lifecycle interface of the Function node type.

operateVnfOpConfig

M

0..1

OperateVnfOpConfig

Configuration parameters for the OperateVnf operation.

Not supported

TOSCA input properties specified with the stop operation of the Lifecycle interface of the Function node type.

changeExtVnfConnectivityO pConfig

M

0..1

ChangeExtVnfConnectivit yOpConfig

Configuration parameters for the

ChangeExtVnfConnectivity operation.

Not supported

Not supported



TOSCA Node Standard Lifecycle interface
interfaces:
  Standard:
    create: # operation to create the node
      inputs:  # All parameters of InstantiateVnfOpConfig go here, one by one
        param111:
          description: describe it
          type: string
          constraints: #
    configure: # operation to create the node
      inputs:
        paramABC:
          description: describe it
          type: string
          constraints: #
    start: # operation to start the node
      inputs:
        paramABC:
          description: describe it
          type: string
          constraints: #
    stop: # operation to stop the node
      inputs: # All parameters of OperateVnfOpConfig go here, one by one
        minGracefulStopTimeout:
          description: describe it
          type: scalar-unit.time
          constraints: #
        maxRecommendedGracefulStopTimeout:
          description: describe it
          type: scalar-unit.time
          constraints: #
        paramXYZ:
          description: describe it
          type: string
    delete: # operation to terminate the node
      inputs:
        paramABC:  # All parameters of TerminateVnfOpConfig go here, one by one
          description: describe it
          type: string
          constraints: #


InstantiateVnfOpConfig information element

This information element defines attributes that affect the invocation of the InstantiateVnf operation.

NFV: Not implemented

ONAP Data Model: implemented as TOSCA input properties specified with the create operation of the Standard lifecycle interface of the Function node type.


ScaleVnfOpConfig information element

This information element defines attributes that affect the invocation of the ScaleVnf operation.

NFV: Not implemented

ONAP Data Model: implemented as TOSCA properties on the TOSCA scaling policies inside the VNF Implementation Topology


ScaleVnfToLevelOpConfig information element

This information element defines attributes that affect the invocation of the ScaleVnfToLevel operation.

NFV: Not implemented

ONAP Data Model: implemented as TOSCA properties on the TOSCA scaling policies inside the VNF Implementation Topology


HealVnfOpConfig information element

This information element defines attributes that affect the invocation of the HealVnf operation.

NFV: Not implemented

ONAP Data Model: Not implemented


TerminateVnfOpConfig information element

This information element defines attributes that affect the invocation of the TerminateVnf operation.

NFV: Not implemented

ONAP Data Model: implemented as TOSCA input properties specified with the delete operation of the Standard lifecycle interface of the Function node type.

OperateVnfOpConfig information element

This information element defines attributes that affect the invocation of the OperateVnf operation.

1.1.1.8.1                   Attributes

The OperateVnfOpConfig information element shall follow the indications provided in table 7.1.5.8.2-1.

NFV: Not implemented

ONAP Data Model: implemented as TOSCA input properties specified with the stop operation of the Standard lifecycle interface of the Function node type.


Table 7.1.5.8.2-1: Attributes of the OperateVnfOpConfig information element

Attribute

Qualifier

Cardinality

Content

Description

minGracefulStopTimeout

M

1

Number

Minimum timeout value for graceful stop of a VNF instance.

maxRecommendedGracef ulStopTimeout

M

0..1

Number

Maximum recommended timeout value that can be needed to gracefully stop a VNF instance of a particular type under certain conditions, such as maximum load condition. This is provided by VNF provider as information for the operator facilitating the selection of optimal timeout value. This value is not used as constraint.

parameter

M

0..N

Not specified

VNF-specific parameters to be passed when invoking the OperateVnf operation.


ChangeVnfFlavourOpConfig information element

This information element defines attributes that affect the invocation of the ChangeVnfFlavour operation.

NFV: Not implemented

ONAP Data Model: not implemented


ChangeExtVnfConnectivityOpConfig information element

This information element defines attributes that affect the invocation of the ChangeExtVnfConnectivity operation.

NFV: Not implemented

ONAP Data Model: not implemented


Vdu information element

Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM





The Virtualisation Deployment Unit (VDU) is a construct supporting the description of the deployment and operational behaviour of a VNFC. 

A VNFC instance created based on the VDU maps to a single virtualisation container (e.g. a VM).

A UML representation of the Vdu high-level structure is shown in figure 7.1.6.2.1-1.


Node type tosca.nodes.nfv.VDU.Composition

Node type onap.nodes.Function (common for VDU, VFC, VNF)

vduId

M

1

Identifier

Unique identifier of this Vdu in VNFD.

 -

Metadata fields on the node type:

UUID, invariantUUID

name

M

1

String

Human readable name of the Vdu.

Property name on the node type

Property name defined on onap.nodes.Resource node type and inherited by onap.nodes.Function

description

M

1

String

Human readable description of the Vdu.

Property description on the node type

TOSCA keyword description on the node type to describe the whole class of instances.

Property instance_description defined on onap.nodes.Resource node type and inherited by onap.nodes.Function – for description per instance.

intCpd 

M

1..N

VduCpd

Describes network connectivity between a VNFC instance (based on this Vdu) and an internal Virtual Link (VL). See clause 7.1.6.4.

Node templates of type tosca.nodes.nfv.VduCpd inside the VDU.Composition topology

Node templates of type onap.nodes.CP inside the VDU implementation topology

virtualComputeDesc

M

1

Identifier (reference to VirtualComputeDesc)

Describes CPU, Memory and acceleration

requirements of the Virtualisation Container realising this Vdu. See clause 7.1.9.2.2.

Node templates of type tosca.nodes.nfv.Compute inside the VDU.Composition topology

TOSCA requirements of type onap.capability.Compute exhibited by the nodes inside the VDU implementation topology

virtualStorageDesc

M

0..N

Identifier (reference to VirtualStorageDesc)

Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu.

See clause 7.1.9.4.

Node templates of type tosca.nodes.nfv.VirtualStorage inside the VDU.Composition topology

TOSCA requirements of type onap.capability.Storage exhibited by the nodes inside the VDU implementation topology

bootOrder

M

0..N

KeyValuePair

The key indicates the boot index (lowest index defines highest boot priority). The Value references a descriptor from which a valid boot device is created e.g.

VirtualStorageDesc from which a VirtualStorage instance is created. See note 1.

Property boot_order on the tosca.nodes.nfv.VDU.Composition node type

TOSCA orchestrator should deduce the boot order based on the relationships with other nodes (declarative workflow) or on a TOSCA imperative workflow construct explicitly specified in the VNF implementation topology

swImageDesc

M

0..1

SwImageDesc

Describes the software image which is directly loaded on the virtualisation container realising this Vdu. See clause 7.1.6.5. See note 2.

A TOSCA artifact of type tosca.artifacts.nfv.SwImage provided with the tosca.nodes.nfv.VDU.Compute nodes inside a topology

A TOSCA artifact of type tosca.artifacts.Deployment provided with the Function-typed nodes inside a topology

nfviConstraint

M

0..N

String

Describes constraints on the NFVI for the VNFC instance(s) created from this Vdu. For example, aspects of a secure hosting environment for the VNFC instance that involve additional entities or processes.

See note 3.

Property nfvi_constraints on the tosca.nodes.nfv.VDU.Composition node type

Reflected by TOSCA requirements exhibited by the VDU nodes.


monitoringParameter

M

0..N

MonitoringParameter

Defines the virtualised resources monitoring parameters on VDU level. MonitoringParameter is defined in clause 7.1.11.3.

Not supported

Not supported

configurableProperties

M

1

VnfcConfigurableProperties

Describes the configurable properties of all VNFC instances based on this VDU.

See clause 7.1.6.7.

Property configurable_properties on the tosca.nodes.nfv.VDU.Composition node type. Incomplete definition of the data type for this property.

All TOSCA properties defined with the Function-derived node types are by their nature configurable properties


NOTE 1: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used.

NOTE 2: More software images can be attached to the virtualisation container using VirtualStorage resources. See clause 7.1.9.4.

NOTE 3: These are constraints other than stipulating that a VNFC instance has access to a certain resource, as a prerequisite to instantiation. The attributes virtualComputeDesc and virtualStorageDesc define the resources required for instantiation of the VNFC instance.




Cpd information element

Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM





A Cpd information element describes network connectivity to a compute resource or a VL. This is an abstract class used as parent for the various Cpd classes.


Node type tosca.nodes.nfv.Cpd

Node type onap.nodes.CP

cpdId

M

1

Identifier

Identifier of this Cpd information element.

-

Metadata fields on the node type:

UUID, invariantUUID

layerProtocol

M

1

Enum

Identifies which protocol the CP uses for connectivity purposes (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire, etc.). See note.

Property layer_protocol on the node type tosca.nodes.nfv.Cpd

Property protocols on the requirement link of the node type onap.nodes.CP

cpRole

M

0..1

String

Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS.

For example a VNF with a tree flow pattern within the VNF will have legal cpRoles of ROOT and LEAF.

Property cp_role on the node type tosca.nodes.nfv.Cpd

Property cp_protocols on the requirement link of the node type onap.nodes.CP

description

M

0..1

String

Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic).

Property description on the node type tosca.nodes.nfv.Cpd

TOSCA keyword description on the node type to describe the whole class of instances.

Property instance_description defined on onap.nodes.Resource node type and inherited by onap.nodes.Function – for description per instance.

addressData

M

0..N

AddressData

Provides information on the addresses to be assigned to the CP(s) instantiated from this CPD.

Property address_data on the node type tosca.nodes.nfv.Cpd

Attribute address_data on the node type onap.nodes.CP

NOTE:       This information determines, amongst other things, which type of address to assign to the access point at instantiation time.




VduCpd information element

Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM






A VduCpd information element is a type of Cpd and describes network connectivity between a VNFC instance (based on this VDU) and an internal VL.

A VduCpd inherits from the Cpd Class (see clause 7.1.6.3). All attributes of the Cpd are also attributes of the VduCpd.


Node type tosca.nodes.nfv.VduCpd

Node type onap.nodes.CP


intVirtualLinkDesc

M

0..1

Identifier (Reference to

VnfVirtualLinkDesc)

Reference of the internal VLD which this internal CPD connects to.

Requirement virtual_link on the node type tosca.nodes.nfv.VduCpd

Requirement link on the node type onap.nodes.CP


bitrateRequirement

M

0..1

Number

Bitrate requirement on this CP.

Property bitrate_requirement on the node type tosca.nodes.nfv.VduCpd

Property bitrate of the requirement link on the node type onap.nodes.CP


virtualNetworkInterfaceRe quirements

M

0..N

VirtualNetworkInterfa ceRequirements

Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD.

Property virtual_network_interface_requirements on the node type tosca.nodes.nfv.VduCpd

Requirement host of the CP (of the capability type

onap.capabilities.NetworkingInterface)


(inherited attributes)




All attributes inherited from Cpd.

 Supported

 Supported




SwImageDesc information element

Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM






Artifacts of specially defined artifact type tosca.artifacts.nfv.SwImage

Artifacts of the artifact type tosca.artifacts.Deployments from the TOSCA Simple Profile, or any of its derivations.

id

M

1

Identifier

The identifier of this software image.

-

Metadata fields on the artifact type:

UUID, invariantUUID

name

M

1

String

The name of this software image.

Property name of the artifact type


version

M

1

String

The version of this software image.

Property version of the artifact type

Metadata fields on the artifact type:

version

checksum

M

1

String

The checksum of the software image file.

Property checksum of the artifact type

TOSCA does not support checksums with artifact type definition, probably because all well-known image file formats contain their checksum built-in and get checked automatically as part of the installation process.


containerFormat

M

1

String

The container format describes the container file format in which software image is provided.

Property containerFormat of the artifact type

Deduced from the concrete artifact type. For example tosca.artifacts.Deployment.Image.VM.ISO or tosca.artifacts.Deployment.Image.VM.QCOW2, etc.

diskFormat

M

1

String

The disk format of a software image is the format of the underlying disk image.

Property diskFormat of the artifact type

A property of the Compute requirement with the VDU node

minDisk

M

1

Number

The minimal disk size requirement for this software image. The value of the "size of storage" attribute of the VirtualStorageDesc referencing this SwImageDesc shall not be smaller than the value of minDisk.

Property minDisk of the artifact type

The storage_size property of the Compute requirement with the VDU node

minRam

M

0..1

Number

The minimal RAM requirement for this software image. The value of the "size" attribute of VirtualMemoryData of the Vdu referencing this SwImageDesc shall not be smaller than the value of minRam.

Property minRam of the artifact type

The memory_size property of the Compute requirement with the VDU node

size

M

1

Number

The size of this software image.

Property size of the artifact type

Not supported

swImage

M

1

Identifier

(Reference to a

SwImage)

This is a reference to the actual software image. The reference can be relative to the root of the VNF Package or can be a URL.

Property swImage of the artifact type

The standard TOSCA file keyword provided with all artifacts

operatingSystem

M

0..1

String

Identifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used.

Property operatingSystem of the artifact type

Not supported

supportedVirtualisationEn vironment

M

0..N

String

Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image.

Property supportedVirtualizationEnvironment of the artifact type

Not supported




VirtualNetworkInterfaceRequirements information element


Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM





This information element specifies requirements on a virtual network interface.

Data type tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements used for a property on the Cpd nodes

Capability type onap.capabilities.NetworkInterface

used for a requirement on the CP nodes

name

M

0..1

String

Provides a human readable name for the requirement.

Property name of the data type.

Not supported

description

M

0..1

String

Provides a human readable description of the requirement.

Property description of the data type.

Standard TOSCA description keyword with the requirement

supportMandatory

M

1

Boolean

Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE). 

Property supportMandatory of the data type.

Not supported

networkInterfaceRequirem ents

M 

1

Not specified. 

The network interface requirements. An element from an array of key-value pairs that articulate the network interface deployment requirements.

Property requirement of the data type.

Property custom_features on the requirement

nicIoRequirements

M

0..1

Identifier (reference to logicalNodeData)

This references (couples) the CPD with any logical node I/O requirements (for network devices) that may have been created. Linking these attributes is necessary so that so that I/O requirements that need to be articulated at the logical node level can be associated with the network interface requirements associated with the CPD.

Not supported

Property custom_features on the requirement


VnfVirtualLinkDesc information element

The VnfVirtualLinkDesc information element supports providing information about an internal VNF VL.


Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM





The VnfVirtualLinkDesc information element supports providing information about an internal VNF VL.


Node type tosca.nodes.nfv.VnfVirtualLinkDesc

Node type onap.nodes.VL

virtualLinkDescId

M

1

Identifier

Unique identifier of this internal VLD in

VNFD.

-

Metadata fields on the node type:

UUID, invariantUUID

virtualLinkDescFlavour

M

1..N

VirtualLinkDescFlavour

Describes a specific flavour of the VL with specific bitrate requirements. See clause 7.1.8.5.

Not implemented

Not implemented

connectivityType

M

1

ConnectivityType

See clause 7.1.7.3.

Property connectivity_type on the node type

Properties of the Linkable capability exhibited by the VL

testAccess

M

0..N

String

Specifies test access facilities expected on the VL (e.g. none, passive monitoring, or active (intrusive) loopbacks at endpoints).

Property test_access on the node type

Not implemented

description

M

0..1

String

Provides human-readable information on the purpose of the VL (e.g. control plane traffic).

Property description of the node type

TOSCA keyword description on the node type to describe the whole class of instances.

Property instance_description defined on onap.nodes.Resource node type and inherited by onap.nodes.Function – for description per instance.

monitoringParameter

M

0..N

MonitoringParameter

Defines the virtualised resources monitoring parameters on VLD level.

MonitoringParameter is defined in clause 7.1.11.3.

Not implemented

Not implemented


ConnectivityType information element

Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM






Data type tosca.datatypes.nfv.ConnectivityType

Properties layer_protocols and flow_patterns on the onap.capabilities.Linkable capability type

layerProtocol

M

1

Enum

Identifies the protocol this VL gives access to (Ethernet, MPLS, ODU2, IPV4, IPV6, Pseudo-Wire).

Property layer_protocol on the data type

Property layer_protocol on the capability type

flowPattern

M

0..1

String

Identifies the flow pattern of the connectivity (Line, Tree, Mesh).

Property flow_pattern on the data type

Property flow_pattern on the capability type


Information elements related to the DeploymentFlavour

NFV: Not yet implemented

ONAP DM: Not yet implemented

VnfDf information element 

NFV: Not yet implemented

ONAP DM: Not yet implemented

VduProfile information element

NFV: Not yet implemented

ONAP DM: Not yet implemented

VirtualLinkProfile information element

NFV: Not yet implemented

ONAP DM: Not yet implemented

VirtualLinkDescFlavour information element

NFV: Not yet implemented

ONAP DM: Not yet implemented

LinkBitrateRequirements information element

NFV: Not yet implemented

ONAP DM: Not yet implemented

InstantiationLevel information element

NFV: Not yet implemented

ONAP DM: Not yet implemented

ScaleInfo information element

NFV: Not yet implemented

ONAP DM: Implementation based on Scaling policies, not yet "flavored"

VduLevel information element

NFV: Not yet implemented

ONAP DM: Not yet implemented

QoS information element

NFV: Not yet implemented

ONAP DM: Implementation based on QoS policies, not yet "flavored"

LocalAffinityOrAntiAffinityRule information element

NFV: Not yet implemented

ONAP DM: Implementation based on Affinity and Anti-affinity policies (work in progress), not yet "flavored"

AffinityOrAntiAffinityGroup information element

NFV: Not yet implemented

ONAP DM: Implementation based on Affinity and Anti-affinity policies (work in progress), not yet "flavored"


Information elements related to Virtual Resource descriptors


VirtualComputeDesc information element

The VirtualComputeDesc information element supports the specification of requirements related to virtual compute resources.


Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM





The VirtualComputeDesc information element supports the specification of requirements related to virtual compute resources.

Node type tosca.nodes.nfv.VDU.Compute with a capability of  the capability type tosca.capabilities.nfv.VirtualCompute

Node type onap.nodes.Container with a requirement of the capability type onap.capabilities.Compute

virtualComputeDescId

M

1

Identifier

Unique identifier of this

VirtualComputeDesc in the VNFD.

-


logicalNode

M

1..N

logicalNodeData

The logical Node requirements.

Not implemented

Properties architecture and custom_features on the capability type onap.capabilities.Compute

requestAdditionalCapabilities

M

0..N

RequestedAdditional CapabilityData

Specifies requirements for additional capabilities. These may be for a range of purposes. One example is acceleration related capabilities. See clause 7.1.9.5.

Property request_additional_capabilities on the capability type tosca.capabilities.nfv.VirtualCompute

Properties architecture and custom_features on the capability type onap.capabilities.Compute

computeRequirements

M

0..N

Not specified

Specifies compute requirements.

-

-

virtualMemory

M

1

VirtualMemoryData

The virtual memory of the virtualised compute. See clause 7.1.9.3.

Complex-type property virtual_memory on the capability type tosca.capabilities.nfv.VirtualCompute

A set of scalar properties (to allow native TOSCA matching) on the capability type onap.capabilities.Compute

virtualCpu

M

1

VirtualCpuData

The virtual CPU(s) of the virtualised compute. See clause 7.1.9.2.

Complex-type property virtual_cpu on the capability type tosca.capabilities.nfv.VirtualCompute

A set of scalar properties (to allow native TOSCA matching) on the capability type onap.capabilities.Compute


VirtualCpuData information elements

The VirtualCpuData information element supports the specification of requirements related to virtual CPU(s) of a virtual compute resource.


Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM





The VirtualCpuData information element supports the specification of requirements related to virtual CPU(s) of a virtual compute resource.


Data type tosca.datatypes.nfv.VirtualCpu (a complex type with nested sub-properties)

Since TOSCA 1.1 does not support requirement matching with complex-type properties, all CPU-related properties of this element were implemented as a set of scalar-type properties inlined in the capability type onap.capabilities.Compute

cpuArchitecture

M

0..1

String

CPU architecture type. Examples are x86, ARM. The cardinality can be 0 during the allocation request, if no particular CPU architecture type is requested.

Property cpu_architecture on the complex data type

Property architecture on the capability type onap.capabilities.Compute

numVirtualCpu

M

1

Integer

Number of virtual CPUs.

Property num_virtual_cpu on the complex data type

Property num_cpus on the capability type onap.capabilities.Compute

virtualCpuClock

M

0..1

Number

Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested.

Property virtual_cpu_clock on the complex data type

Property cpu_frequency on the capability type onap.capabilities.Compute

virtualCpuOversubscriptio nPolicy

M

0..1

Not specified

The CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads. The cardinality can be 0 during the allocation request, if no particular value is requested.

Property virtual_cpu_oversubscription_policy on the complex data type

Property custom_features on the capability type onap.capabilities.Compute

vduCpuRequirements

M

0..N

Not specified. 

Array of key-value pair requirements on the Compute (CPU) for the VDU.

-

Property custom_features on the capability type onap.capabilities.Compute

virtualCpuPinning

M

0..1

VirtualCpuPinnin gData

The virtual CPU pinning configuration for the virtualised compute resource. See clause 7.1.9.2.4.

Complex-type property virtual_cpu_pinning on the complex data type

Property custom_features on the capability type onap.capabilities.Compute



VirtualMemoryData information element

The VirtualMemoryData information element supports the specification of requirements related to virtual memory of a virtual compute resource.


Attribute

Qualifier

Cardinality

Content

Description

NFV

O





The VirtualMemoryData information element supports the specification of requirements related to virtual memory of a virtual compute resource.

Data type tosca.datatypes.nfv.VirtualMemory (a complex type with nested sub-properties)

Since TOSCA 1.1 does not support requirement matching with complex-type properties, all memory-related properties of this element were implemented as a set of scalar-type properties inlined in the capability type onap.capabilities.Compute

virtualMemSize

M

1

Number

Amount of virtual Memory (e.g. in MB).

Property virtual_mem_size in the data type

Property mem_size in the capability type onap.capabilities.Compute

virtualMemOversubscriptio nPolicy

M

0..1

Not specified

The memory core oversubscription policy in terms of virtual memory to physical memory on the platform. The cardinality can be 0 during the allocation request, if no particular value is requested.

Property virtual_mem_oversubscription_policy in the data type

Property custom_features in the capability type onap.capabilities.Compute

vduMemRequirements

M

0..N

Not specified. 

Array of key-value pair requirements on the memory for the VDU.

-

Property custom_features in the capability type onap.capabilities.Compute

numaEnabled

M

0..1

Boolean

It specifies the memory allocation to be cognisant of the relevant process/core allocation. The cardinality can be 0 during the allocation request, if no particular value is requested.

Property num_enabled in the data type

Property custom_features in the capability type onap.capabilities.Compute


VirtualStorageDesc information element

The VirtualStorageDesc information element supports the specifications of requirements related to virtual storage resources.


Attribute

Qualifier

Cardinality

Content

Description

NFV

ONAP DM





The VirtualStorageDesc information element supports the specifications of requirements related to virtual storage resources.


Node type tosca.nodes.nfv.VDU.VirtualStorage

A requirement of the capability type onap.capabilities.Storage exhibited by the node type onap.nodes.Compute.


id

M

1

Identifier

Unique identifier of this VirtualStorageDesc in the VNFD.

Property id on the node type

Not implemented

typeOfStorage

M

1

String

Type of virtualised storage resource  (e.g. volume, object).

Property type_of_storage on the node type

Property storage_type on the capability type

sizeOfStorage

M

1

Number


Size of virtualised storage resource  (e.g. size of volume, in GB).

Property size_of_storage on the node type

Property storage_size on the capability type

vduStorageRequirements

M

0..N

Not Specified

An array of key-value pairs that articulate the storage deployment requirements.

Not implemented

Property storage_type on the capability type

rdmaEnabled

M

0..1

Boolean

Indicate if the storage support RDMA.

Property rdma_enabled on the node type

Property custom_features on the capability type

swImageDesc

M

0..1

Identifier

(Reference to a

SwImageDesc)

Software image to be loaded on the VirtualStorage Resource created based on this VirtualStorageDesc.

Not implemented

Not implemented

  • No labels