Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page is used to store what have reached agreement for the parent page "Requirements for VNFD". 

Table of Contents
printablefalse

Class:

...

 VnfDf


Attribute   Name

Type

Mult.

Stereotypes

Description

localAffinityOrAntiAffinityRule

LocalAffinityOrAntiAffinityRule

flavorId

Identifier

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Identifier of this DF within the VNFD.



description

String

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Human readable description of the DF.



_virtuaLlinkProfile

VirtualLinkProfile

0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Defines the internal VLD along with additional data   which is used in this DF.  NOTE 1: This   allows for different VNF internal topologies between DFs.  NOTE 2: virtualLinkProfile needs to be   provided for all VLs that the CPs of the VDUs in the VDU profiles connect to.



_instantiationLevel

InstantiationLevel

1..*

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Describes the various levels of resources that can be   used to instantiate the VNF using this flavour.  Examples: Small, Medium, Large.  If there is only one "instantiationLevel"   entry, it shall be treated as the default instantiation level for this DF.



_affinityOrAntiAffinityGroup

AffinityOrAntiAffinityGroup

0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Specifies affinity or anti-affinity

rules

relationship   applicable between the

VLs based on this VnfVirtualLinkDesc.  When the cardinality is greater than 1,   both affinity rule(s) and anti-affinity rule(s) with different scopes are   applicable to the VLs based on this VnfVirtualLinkDesc.

virtualisation containers (e.g. virtual machines) to   be created using different VDUs or internal VLs to be created using different   VnfVirtualLinkDesc(s) in the same affinity or anti-affinity group.  NOTE: In the present specification,   including either VDU(s) or VnfVirtualLinkDesc(s) into the same affinity or   anti-affinity group is supported. Extension to support including both VDU(s)   and VnfVirtualLinkDesc(s) into the same affinity or anti-affinity group is   left for future specification.



_scalingAspect

ScalingAspect

0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

The scaling aspects supported by this DF of the VNF.   scalingAspect shall be present if the VNF supports scaling.



_vduProfile

VduProfile

1..*

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Describes additional instantiation data for the VDUs   used in this flavor.



 _vduCpdProfile VduCpdProfile 1..* OpenModelAttribute
  • isInvariant: false
  • valueRange:  no range constraint
  • support:   
    MANDATORY

Experimental

 

Describes additional instantiation data for the vduCpds used in this flavour.

_placementGroup

PlacementGroup

0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Determine where VNFC's (VDU's) are placed with   respect to the VNF



_baseConfigGroup

BaseConfigGroup

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

BaseConfigGroup may set Access Control Lists (ACL's)   and establish security groups and server groups. BaseConfigGroup   creates/establishs storage for the VM's (OpenStack Cinder). BaseConfigGroup   may establish internal networks such as OAM (VNF Mgmt) or MNS (Maintenance   & Surveillance)  established.



_deploymentGroup

DeploymentGroup

0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

DeploymentGroup provides the minimum viable VDU and   associated VNFC configuration for a useable VNF.



_scalinggroup

ScalingGroup

0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Identifies the vaious scaling groups within the VNF   which identify which vnfcs that need to be scaled together.

Class: VduCpdProfile(Experimental)


Attribute   Name

Type

Mult.

Stereotypes

Description

_vduCpd

VduCpd

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Experimental

Uniquely identifies a VduCpd.



_affinityOrAntiAffinityGroup

AffinityOrAntiAffinityGroup

0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Experimental

Identifier(s) of the affinity or anti-affinity group(s) the VduCpd belongs t

Class: VduProfile


Attribute   Name

Type

Mult.

Stereotypes

Description

 Rationale

vdudId

Identifier

1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Uniquely identifies a VDU.

 

 

 

minNumberOfInstances

Integer

1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

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

 

 

 

maxNumberOfInstances

Integer

1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

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

 

 

 

localAffinityOrAntiAffinityRule

LocalAffinityOrAntiAffinityRule

0..*

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

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

 

 

 

affinityOrAntiAffinityGroupId

Identifier

0..*

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Identifier(s) of the affinity or   anti-affinity group(s) the

VnfVirtualLinkDesc

VDU belongs to.    NOTE: Each identifier references an

 

affinity or anti-affinity group   which expresses affinity or anti-affinity

  relationship

relationships between the

VL

virtualisation   container(s) (e.g. virtual machine(s)) to be created using this

VnfVirtualLinkDesc

VDU and the

VL

  virtualisation container(s) (e.g. virtual machine(s)) to be created using  

using

other

VnfVirtualLinkDesc

VDU(s) in the same group.

 

 

maxBitRateRequirements
 

watchdog

LinkBitrateRequirements

String

0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Specifies the minimum bitrate requirements   for a VL instantiated according to this profile.

Watchdog action to be triggered by the VIM   for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc.

 

 

 
minBitRateRequirements

vmBootUpTimeOut

LinkBitrateRequirements

Integer

0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Specifies the minimum bitrate requirements   for a VL instantiated according to this profile.

Timeout value for the VNFM to wait before   the successful booting up of the VDU.

 

 

 
initiationParameters

flavorExtraSpecs

KeyValuePair

0..*

Experimental

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Additional expansion requirements for  Infrastructure layer, e.g. HA property (Host Aggregate label).

 

 

This attribute is the extension for Openstack flavor, currently including:

  •  HA property (Host Aggregate label).
  • CPU allocation strategy: whether two vCPUs need binding core together or not.
  • Multi-queue vNic: whether to use multi-queue network card mode or not.
  • Real-time performance of network elements: whether to open this function or not.


Class: AffinityOrAntiAffinityGroup


Attribute   Name

Type

Mult.

Access

Stereotypes

Description

groupIdIdentifier1 RW OpenModelAttribute
  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

 Identifies an affinity or anti-affinity group to which the affinity or anti-affinity rule applies.

type

RuleType

1

RW

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Specifies initiation parameters for the   virtual link.

 

 

_virtualLinkDescFlavour

VirtualLinkDescFlavour

Preliminary

 Specifies whether the rule is an affinity rule or an anti-affinity   rule.

 

 

scope

RuleScope

1

RW

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

 Specifies the scope of the rule.

  • NFVI_POP
  • ZONE
  • ZONE_GROUP
  • NFVI_NODE
  • NFVI_NIC

 

Class: VirtualStorageDesc


Attribute   Name

Type

Mult.

Stereotypes

Description

 Rationale

id

Identifier

1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Identifies a flavour within the   VnfVirtualLinkDesc.

Unique identifier of this   VirtualStorageDesc in the VNFD.

 

 

 
_virtualLinkDesc

typeOfStorage

LinkDesc

String

1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Uniquely identifies a Vnf VLD.

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

 

 

 

virtualLinkProtocolData

(Aligned with IFA 011v2.5.1)

VirtualLinkProtocolData

sizeOfStorage

Number

1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

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

 

 

 

vduStorageRequirements

KeyValuePair

0..*

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Specifies the protocol data for a VL instantiated according to this profile. Cardinality 0 is used when no   protocol data needs to be specified.

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

 

 

 

Datatype:  VirtualLinkProtocolData (Aligned with IFA 011v2.5.1)

Attribute   Name

Type

Mult.

Access

Stereotypes

Description

associatedLayerProtocol

LayerProtocol

1

RW

rdmaEnabled

Boolean

0..1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Obsolete

Indicate if the storage support RDMA.

 

 

 

swImageDesc

Identifier

0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 One of the values of the attribute layerProtocol of the ConnectivityType IE.

(Refer to ConnectivityType)

l2ProtocolData

L2ProtocolData

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

 

 

 

multiAttach

Boolean

0..1

RW

Experimental

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Specifies the L2 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise

Indicating whether a vDisk is a shared volume in VNFD.

 

 

l3ProtocolData

L3ProtocolData

Each vDisk corresponds to one volume, it should set if the volume can be shared by other VMs.

_storageQos

StorageQos

0..1

RW

Experimental

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Specifies the L3 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise.

 

 

Describe storage Qos requirements.

 

 

Describe special Qos requirements for storage, see datatype"StorageQos" for details.


_volumeType


VolumeType

0..1

Experimental

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Describe the volume type a storage is based on. 

 

 

 In Openstack, a backend can have multiple volume types to choose, when instantiate a vStorage, must specify one volume type.

Datatype:  L2ProtocolData

Attribute   Name

Type

Mult.

Access

Stereotypes

Description

 Rationale

name

(Aligned with IFA 011v2.5.1)

String

0..1

RW

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 Network name associated with this L2 protocol.

 

 

 

 networkType

(Aligned with IFA 011v2.5.1)

 NetworkType  0..1 RW  OpenModelAttribute
  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Specifies the network type for this L2 protocol. Possible values: FLAT, VLAN, VXLAN, GRE. 

 vlanTransparent

(Aligned with IFA 011v2.5.1)

 Boolean 0..1  RW   OpenModelAttribute
  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
 Indicating whether "VLAN Transparent Mode" is supported. Default is "FALSE" if not specified otherwise. 
segmentationId String 0..1

RW

 

Experimental 

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
 Network segment ID. The id of vlan/vxlan.
routerExternal Boolean  0..1 RW

Experimental    

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
 Specify if a vrouter comes from an external network.There are two usage situations of vrouters, one is using in the virtual network internally, another is using to connet to the external network. This attribute shows the two situations, if "true", then the vrouter is using to connect another network; if "false", then using internally.

Datatype:  L3ProtocolData

ttribute   Name

Type

Mult.

Access

Stereotypes

Description

 Rationale

cidr

(Aligned with IFA 011v2.5.1)

 String

1

RW

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 Specifies the CIDR (Classless Inter- Domain Routing) of this L3 protocol.

See note.

 

 

 gatewayIp

(Aligned with IFA 011v2.5.1)


 IpAddress IpAddress

 0..1 RW OpenModelAttribute
  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Specifies the gateway IP address for this L3 protocol. See note. 

ipVersion

(Aligned with IFA 011v2.5.1)



 IpVersion IpVersion 1 RW OpenModelAttribute
  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Specifies IP version of this L3 protocol.

Value:
• IPV4.
• IPV6.

 

ipAllocationPools  

(Aligned with IFA 011v2.5.1)

 KeyValuePair0..N RW OpenModelAttribute
  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Specifies the allocation pools with start and end IP addresses for this L3 protocol. See note .

ipv6AddressMode

(Aligned with IFA 011v2.5.1)


Ipv6AddressMode0..1  RW OpenModelAttribute
  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Specifies IPv6 address mode. Possible values:

• SLAAC.

• DHCPV6-STATEFUL.

• DHCPV6-STATELESS.

May be present when the value of the ipVersion attribute is "IPV6" and shall be absent otherwise. See Note.


 

 dhcpEnabled 

(Aligned with IFA 011v2.5.1)

 

  Boolean 0..1  RW OpenModelAttribute
  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Indicating Indicates whether DHCP (Dynamic Host Configuration Protocol) is enabled . Default is "FALSE" if not specified otherwise. or disabled for this L3 protocol. See note. 
ipv6RaModeIpv6AddressMode0..1 RW Experimental 

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Specifies IPv6 address mode for vrouter. Possible values:

• SLAAC.

• DHCPV6-STATEFUL.

• DHCPV6-STATELESS.

May be present when the value of the ipVersion attribute is "IPV6" and shall be absent otherwise. Must be present when the VLAN/VXLAN connects to one or more vrouters. 

Note2: The value of  ipv6RaMode and ipv6AddressMode must be same.

This attribute comes from Openstack demand, the address mode should be separately set for vRouter and dhcp. The usage for the  ipv6RaMode and ipv6AddressMode has the following situation:

  • Both attributes don't specify address modes.
  •  Ipv6RaMode doesn't specify an address mode, while ipv6AddressMode has one of the modes for dhcp
  • Both attributes have to set address mode, then they must be the same value.
dnsNameServers String 0..N  RW

Experimental  

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
DNS server list.See description.
hostRoutes  KeyValuePair 0..N RW

Experimental  

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
Static routing list, including estination and nexthop information. See description. Estination and nexthop will be provided by network elements.
Note: If this attribute is included in the VNFD, the attribute value shall be provided at run-time, unless a default value is provided at design time in the VNFD. If a default value is provided at design-time, this value may be overridden at run-time.      

Class:  StorageQos

ribute   Name

Type

Mult.

Access

Stereotypes

Description

 Rationale

qosId

Identifier

1

RW

 Experimental 

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 Unique identifier of the storage Qos in VNFD.

 

 

 See description.

qosName

String

1

RW

 Experimental 

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 Name of storage QoS.

 

 

 Human readable name, corresponding to the Id.

consumer

ConsumerScope

1

RW

 Experimental 

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 Consumer type.

  • BACK_END
  • LOCAL

 

Identify the volume which a Storge is based on comes from the backend or local.

qosSpecs

KeyValuePair

0..*

RW

 Experimental 

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 Describe qualities of Qos:total read/write rate{total_bytes_sec}、total read/write IOPS{total_iops_sec}.



 

 

 This is used for the information of basic stroge Qos requirements.

Class: VolumeType

Attribute   Name

Type

Mult.

Access

Stereotypes

Description

 Rationale

volumeTypeId

Identifier

1

RW

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 Unique identifier of volume type in VNFD.

 

 

See description.

volumeTypeName

String

1

RW

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 Name of volume type.

 

 

Human readable name, corresponding to the Id.

backendName

String

1

RW

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Name of the object linking to the backend distributed storage. (Name in cinder) 

 

 

 Each volume type has a corresponding backend, the name is also the name in Openstack Cinder configuration.