This page shows the current agreement on the design time information model of resources for ONAP R2.

NOTE: Differences with ETSI IFA011 v2.3.2 (draft) are marked in orange.

The "SOL001 Mapping" column shows the mapping of each Attribute to SOL001 specification (TOSCA model).  This mapping is based on SOL001 v0.5.0 + all of approved contribution from SOL WG#55. This table is work in progress.

Class: VNFD/VNFDesc

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping
vnfdIdIdentifier1

Identifier of this VNFD information element. This attribute shall be globally unique.

NOTE: 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.
support: MANDATORY

tosca.nodes.nfv.VNF

as properties

vnfProviderString1Provider of the VNF and of the VNFD.support: MANDATORY

tosca.nodes.nfv.VNF

as properties

vnfProductNameString1Name to identify the VNF Product. Invariant for the VNF Product lifetime.support: MANDATORY

tosca.nodes.nfv.VNF

as properties

vnfSoftwareVersionString1Software version of the VNF. This is changed when there is any change to the software that is included in the VNF Package.support: MANDATORY

SOL001: tosca.nodes.nfv.VNF

as properties

Modeled as “string”

vnfdVersionString1Identifies the version of the VNFD.support: MANDATORY

tosca.nodes.nfv.VNF

as properties

Modeled as “string”

vnfProductInfoNameString0..1Human readable name for the VNF Product. Can change during the VNF Product lifetime.support: MANDATORY

tosca.nodes.nfv.VNF

as properties

vnfProductInfoDescriptionString0..1Human readable description of the VNF Product. Can change during the VNF Product lifetime.support: MANDATORY

tosca.nodes.nfv.VNF

as properties

vnfmInfoString0..NIdentifies VNFM(s) compatible with the VNF described in this version of the VNFD.

support: MANDATORY

valueRange: use the name of micro-service of the vnfm drive. For vendor specific VNFM, the value composes of "vendorname" and "vnfmdriver", e.g. "mycompanyvnfmdriver"; for generic VNFM, the value is "gvnfmdriver".

tosca.nodes.nfv.VNF

as properties


localizationLanguageString0..N

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

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


support: MANDATORY

valueRange: refer to ISO936 https://www.iso.org/iso-639-language-codes.html

tosca.nodes.nfv.VNF

as properties

Modeled as “string”

defaultLocalizationLanguageString0..1

Default localization language that is instantiated if no information about selected localization language is available.

support: MANDATORY

valueRange: refer to ISO936 https://www.iso.org/iso-639-language-codes.html

condition: Shall be present if "localizationLanguage" is present and shall be absent otherwise.

tosca.nodes.nfv.VNF

as properties

Modeled as “string”

vduVDU/VDUDesc1..NVirtualisation Deployment Unit.support: MANDATORYtosca.nodes.VDU.Compute
virtualComputeDescVirtualComputeDesc1..NDefines descriptors of virtual compute resources to be used by the VNF.support: MANDATORY

tosca.nodes.VDU.Compute

tosca.capabilities.nfv.VirtualCompute

virtualStorageDescVirtualStorageDesc0..NDefines descriptors of virtual storage resources to be used by the VNF.support: MANDATORYtosca.nodes.nfv.VDU.VirtualStorage
intVirtualLinkDescVirtualLinkDesc/VnfVirtualLinkDesc0..NRepresents the type of network connectivity mandated by the VNF provider between two or more CPs which includes at least one internal CP.support: MANDATORYtosca.nodes.nfv.VnfVirtualLinkDesc
vnfReservedCpdVduCpd0..NReserved IP Address for VNF which is not bounded to any specific VNFC, but assigned manually from outside and potentially shared as a floating IP among VNFCs.support: MANDATORYN/A in SOL001
vnfExtCpdVnfExtCpd/VNFExtCPDesc1..NDescribes external interface(s) exposed by this VNF enabling connection with a VL.support: MANDATORY

tosca.nodes.nfv.VnfExtCpd

deploymentFlavourVnfDf/VNFDeploymentFlavor1..NDescribes specific DF(s) of a VNF with specific requirements for capacity and performance.support: MANDATORYTBD
configurablePropertiesVnfConfigurableProperties0..1Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing).support: MANDATORYtosca.datatypes.nfv.VnfConfigurableProperties
modifiableAttributesVnfInfoModifiableAttributes0..1

Describes the modifiable attributes of the VNF.

Editor's note: need check the usage of this attribute

support: MANDATORYtosca.datatypes.nfv.VnfInfoModifiableAttributes
lifeCycleManagementScript

LifeCycleManagementScript/

LifeCycleManagementOperationDesc

0..NIncludes a list of events and corresponding management scripts performed for the VNF.support: MANDATORYtosca.interfaces.nfv.vnf.lifecycle.Nfv
elementGroupVnfdElementGroup0..NDescribes the associated elements of a VNFD for a certain purpose during VNF lifecycle management.support: MANDATORYtosca.groups.nfv.ElementGroup
vnfIndicatorVnfIndicator0..NDeclares the VNF indicators that are supported by this VNF.support: MANDATORYTBD
logoString0..1File path of the vendor specified logo.support: MANDATORYN/A in SOL001
guideString0..1UUID of the vendor guide/documentation which is attached to VNF and can be downloaded from the model.support: MANDATORYN/A in SOL001






Class: VDU/VDUDesc

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping
vduIdIdentifier1

Unique identifier of this Vdu in VNFD.

support: MANDATORYnot required
nameString1Human readable name of the Vdu.support: MANDATORYtosca.nodes.VDU.Compute
descriptionString1Human readable description of the Vdu.support: MANDATORYtosca.nodes.VDU.Compute
vduCpdVduCpd/VDUCPDesc1..NDescribes network connectivity between a VNFC instance (based on this Vdu) and an Virtual Link (VL).support: MANDATORY

tosca.nodes.nfv.VduCpd

tosca.nodes.nfv.Cpd

virtualComputeDescIdentifier (reference to VirtualComputeDesc)1Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

virtualStorageDescIdentifier (reference to VirtualStorageDesc)0..NDescribes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu.support: MANDATORY

tosca.capabilities.nfv.VirtualStorage

bootOrderKeyValuePair/NameValuePair0..N

Boot order of valid boot devices.

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

support: MANDATORY

valueRange: "key/name" indicates the the boot index (lowest index defines highest boot priority). "value" references a descriptor from which a valid boot device is created e.g. VirtualStorageDesc from which a VirtualStorage instance is created.

tosca.nodes.VDU.Compute
swImageDescSwImageDesc

0..1

Editor's note: the scenario of using "0" needs to be clarified.

Describes the software image which is directly loaded on the virtualisation container realising this Vdu.

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

support: MANDATORY

tosca.artifacts.nfv.SwImage

nfviConstraintKeyValuePair/NameValuePair0..N

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.

NOTE: 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.

support: MANDATORY

valueRange: "key/name" includes "AvailabilityZone", "HostAggregates".

tosca.nodes.VDU.Compute
monitoringParameterMonitoringParameter0..NDefines the virtualised resources monitoring parameters on VDU level.support: MANDATORY

tosca.capabilities.nfv.Metric

configurablePropertiesVnfcConfigurableProperties1Describes the configurable properties of all VNFC instances based on this VDU.support: MANDATORY

tosca.nodes.VDU.Compute:

as properties: tosca.datatypes.nfv.VnfcConfigurableProperties

injectFilesString0..NDescribes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process.support: MANDATORYN/A in SOL001






Class: SwImageDesc

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping
idIdentifier1The identifier of this software image.support: MANDATORYNot required
nameString1The name of this software image.support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

versionString1The version of this software image.support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

checksumString1The checksum of the software image file.support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

containerFormatString1The container format describes the container file format in which software image is provided.support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

diskFormatString1The disk format of a software image is the format of the underlying disk image.support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

minDiskNumber (recommended DM type: Scalar-Unit-Size)1The 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.support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

minRamNumber (recommended DM type: Scalar-Unit-Size)0..1The 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.support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

sizeNumber (recommended DM type: Scalar-Unit-Size)1The size of this software image.support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

swImage

Identifier (Reference to a SwImage)1This 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.support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

operatingSystemString0..1

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.

support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

supportedVirtualisationEnvironmentString0..NIdentifies the virtualisation environments (e.g. hypervisor) compatible with this software image.support: MANDATORY

tosca.artifacts.nfv.SwImage

as properties

Class: VirtualComputeDesc

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping
virtualComputeDescIdIdentifier1Unique identifier of this VirtualComputeDesc in the VNFD.support: MANDATORYNot required
logicalNodeLogicalNodeData/LogicialNodeDesc1..NThe logical Node requirements.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties

tosca.datatypes.nfv.LogicalNodeData
requestAdditionalCapabilitiesRequestedAdditionalCapabilityData0..NSpecifies requirements for additional capabilities. These may be for a range of purposes. One example is acceleration related capabilities.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties

tosca.datatypes.nfv.RequestedAdditionalCapability
computeRequirementsKeyValuePair/NameValuePair0..NSpecifies compute requirements.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties

virtualMemoryVirtualMemoryData/VirtualMemoryDesc1The virtual memory of the virtualised compute.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties

tosca.datatypes.nfv.VirtualMemory
virtualCpuVirtualCpuData/VirtualCPUDesc1The virtual CPU(s) of the virtualised compute.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties

tosca.datatypes.nfv.VirtualCpu

Class: VirtualCpuData/VirtualCPUDesc

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping
cpuArchitectureString0..1CPU architecture type. Examples are x86, ARM. The cardinality can be 0 during the allocation request, if no particular CPU architecture type is requested.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties tosca.datatypes.nfv.VirtualCpu

numVirtualCpuInteger1Number of virtual CPUs.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties tosca.datatypes.nfv.VirtualCpu

virtualCpuClockNumber (recommended DM type: Scalar-Unit-Freq)0..1Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties tosca.datatypes.nfv.VirtualCpu

virtualCpuOversubscriptionPolicyString0..1The 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.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties tosca.datatypes.nfv.VirtualCpu

vduCpuRequirementsKeyValuePair/NameValuePair0..NArray of key-value pair requirements on the Compute (CPU) for the VDU.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties tosca.datatypes.nfv.VirtualCpu

virtualCpuPinningVirtualCpuPinningData0..1The virtual CPU pinning configuration for the virtualised compute resource.

support: MANDATORY

editor's note: need to check whether can be optional

tosca.capabilities.nfv.VirtualCompute

as properties tosca.datatypes.nfv.VirtualCpu

Class: VirtualMemoryData/VirtualMemoryDesc

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping
virtualMemSizeNumber (recommended DM type: Scalar-Unit-Size)1Amount of virtual Memory (e.g. in MB).support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties tosca.datatypes.nfv.VirtualMemory

virtualMemOversubscriptionPolicyString0..1The 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.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties tosca.datatypes.nfv.VirtualMemory

vduMemRequirementsKeyValuePair/NameValuePair0..NArray of key-value pair requirements on the memory for the VDU.support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties tosca.datatypes.nfv.VirtualMemory

numaEnabledBoolean
0..1

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.

support: MANDATORY

tosca.capabilities.nfv.VirtualCompute

as properties tosca.datatypes.nfv.VirtualMemory

Class: VirtualStorageDesc

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping

id

Identifier

1

Unique identifier of this VirtualStorageDesc in the VNFD.

support: MANDATORY

tosca.nodes.nfv.VDU.VirtualStorage

as properties

typeOfStorage

String

1

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

support: MANDATORY

tosca.nodes.nfv.VDU.VirtualStorage

as properties

sizeOfStorage

Number (recommended DM type: Scalar-Unit-Size)

1

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

support: MANDATORY

tosca.nodes.nfv.VDU.VirtualStorage

as properties

vduStorageRequirements

KeyValuePair/NameValuePair

0..N

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

support: MANDATORY

tosca.nodes.nfv.VDU.VirtualStorage

as properties

rdmaEnabled

Boolean

0..1

Indicate if the storage support RDMA.

support: MANDATORY

tosca.nodes.nfv.VDU.VirtualStorage

as properties

swImageDesc

Identifier (Reference to SwImageDesc)

0..1

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

support: MANDATORY

tosca.artifacts.Deployment.Image


Class: LogicalNodeData/LogicalNodeDesc

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping

logicalNodeRequirements

KeyValuePair/NameValuePair

0..N

The logical node-level compute, memory and I/O requirements. An array of key-value pairs that articulate the deployment requirements.

This could include the number of CPU cores on this logical node, a memory configuration specific to a logical node (e.g. such as available in the Linux kernel via the libnuma library) or a requirement related to the association of an I/O device with the logical node.

support: MANDATORYtosca.datatypes.nfv.LogicalNodeData

Class: Cpd/CPDesc

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping

cpdId

Identifier

1

Identifier of this Cpd information element.

support: MANDATORYNot required

cpRole

String

0..1

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.

support: MANDATORY

tosca.nodes.nfv.Cpd as Properties

description

String

0..1

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

support: MANDATORYtosca.nodes.nfv.Cpd as Properties

cpProtocol

CpProtocolData

1..N

Identifies the protocol layering information the CP uses for connectivity purposes and associated information. There shall be one cpProtocol for each layer protocol as indicated by the attribute layerProtocol.

Editor's note: the attribute "layerProtocol" still needs further discussion and not included in this table.

support: MANDATORYtosca.nodes.nfv.Cpd as Properties

trunkMode

Boolean

1

Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other).

support: MANDATORYtosca.nodes.nfv.Cpd as Properties

allowedAddressData

AddressData

0..N

For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD.

support: MANDATORY

N/A in SOL001

Class: VduCpd/VDUCPDesc

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping

bitrateRequirement

Number (recommended DM type: Scalar-Unit-Rate)

0..1

Bitrate requirement on this CP.

support: MANDATORYtosca.nodes.nfv.VduCpd as properties

vnicName

String

0..1

Describes the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process.

support: MANDATORYN/A in SOL001

vnicOrder

Integer

0..1

Describes the order to create the vNIC within the scope of this Vdu.

support: MANDATORYN/A in SOL001

vnicType

Enum

0..1

Describes the type of the vNIC this CP attaches to.

support: MANDATORY

valueRange: normal, macvtap, direct, baremetal, direct-physical and virtio-forwarder

N/A in SOL001
virtualNetworkInterfaceRequirementsVirtualNetworkInterfaceRequirements0..NSpecifies requirements on a virtual network interface realising the CPs instantiated from this CPD.support: MANDATORY

tosca.nodes.nfv.VduCpd as properties

tosca.datatypes.nfv. VirtualNetworkInterfaceRequirements

(inherited attributes)

All attributes inherited from Cpd.

Class: VduProfile

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping

vduId

Identifier (Reference to Vdu)

1

Uniquely identifies a VDU.

support: MANDATORY

minNumberOfInstances

Integer

1

Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour.

support: MANDATORYtosca.datatypes.nfv.VduProfile as properties

maxNumberOfInstances

Integer

1

Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour.

support: MANDATORYtosca.datatypes.nfv.VduProfile as properties

localAffinityOrAntiAffinityRule

LocalAffinityOrAntiAffinityRule

0..N

Specifies affinity or anti-affinity rules applicable between the virtualisation containers (e.g. virtual machines) to be created based on this VDU.

When the cardinality is greater than 1, both affinity rule(s) and anti-affinity rule(s) with different scopes (e.g. "Affinity with the scope resource zone and anti-affinity with the scope NFVI node") are applicable to the virtualisation containers (e.g. virtual machines) to be created based on this VDU.

support: MANDATORY

modeled as policy types
affinityOrAntiAffinityGroupIdIdentifier0..N

Identifier(s) of the affinity or anti-affinity group(s) the VDU belongs to.

NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity relationships between the virtualisation container(s) (e.g. virtual machine(s)) to be created using this VDU and the virtualisation container(s) (e.g. virtual machine(s)) to be created using other VDU(s) in the same group.

support: MANDATORYmodeled as policy types
watchdogString0..1Watchdog action to be triggered by the VIM for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc.support: MANDATORYN/A in SOL001
vmBootUpTimeOutInteger0..1Timeout value for the VNFM to wait before the successful booting up of the VDU.support: OPTIONALN/A in SOL001

Class: VirtualNetworkInterfaceRequirements

Attribute NameTypeMultiplicityDescriptionApplied StereotypesSOL001 Mapping

name

String

0..1

Provides a human readable name for the requirement.

support: MANDATORYtosca.datatypes.nfv. VirtualNetworkInterfaceRequirements as properties

description

String

0..1

Provides a human readable description of the requirement.

support: MANDATORYtosca.datatypes.nfv. VirtualNetworkInterfaceRequirements as properties
supportMandatoryBoolean1Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or desirable (FALSE).support: MANDATORYtosca.datatypes.nfv. VirtualNetworkInterfaceRequirements as properties
networkInterfaceRequirementsKeyValuePair/NameValuePair0..NThe network interface requirements. An element from an array of key-value pairs that articulate the network interface deployment requirements.support: MANDATORY tosca.datatypes.nfv. VirtualNetworkInterfaceRequirements as properties
  • No labels

1 Comment

  1. I don't think this mapping, as specified above,  supports HPA requirements. Attributes such as vduCpuRequirements and vduMemRequirements (as examples) are not actually in the tosca.datatypes.nfv.VirtualCpu and tosca.datatypes.nfv.VirtualMemory as specified in SOL001. The definitions in SOL001 say they are modeled "as defined in TOSCA-Simple-Profile-NFV-v1.0".   When I go to that spec, these attributes are not present. I think that is because SOL001 actually mapped the VirtualCpu and VirtualMemory classes and not the VirtualCpuData (VirtualCpuDesc) and VirtualMemoryData (VirtualMemoryDesc). I question their mappings.