****** NOTE: This page is updated to R3 NS implementation in VFC project and also submit papyrus model in gerrit. ********
Class Diagram
Classes
NSD - Network Service Descriptor
The NSD class is a deployment template whose instances are used by the NFVO for the lifecycle management of NSs. For all attributes in this class, the Producer is SDC and the Consumer is SDC/UUI/VFC
Applied stereotypes:
- Preliminary
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
nsdIdentifier | Identifier | 1 | Preliminary OpenModelAttribute
| Identifier of this NSD class. It globally uniquely identifies an instance of the NSD |
designer | String | 1 | Preliminary OpenModelAttribute
| Identifies the designer of the NSD. |
version | Version | 1 | Preliminary OpenModelAttribute
| Identifies the version of the NSD. |
nsdName | String | 1 | Preliminary OpenModelAttribute
| Provides the human readable name of the NSD. |
nsdInvariantId | Identifier | 1 | Preliminary OpenModelAttribute
| Identifies an NSD in a version independent manner. This attribute is invariant across versions of NSD. |
autoScalingRule | Rule | 0..* | Preliminary OpenModelAttribute
| Specifies a rule to trigger a scaling action on a NS instantiated according to the NSD. NOTE 1: The rule is based on a combination of assertions on the values of virtualised resource-related performance metrics and VNF Indicators identified by the monitoredInfo attribute. NOTE 2: There may be multiple data sources (each identified as monitoredInfo) per rule |
monitoredInfo | TBD | 0..* | Preliminary OpenModelAttribute
| Identifies either a virtualised resource-related performance metric or a VNF Indicator. |
lifeCycleManagementScript | NsLifeCycleManagementScript | 0..* | Preliminary OpenModelAttribute
| Provides a life cycle management script written in a Domain Specific Language (DSL). |
_virtualLinkDesc | 0..* | Preliminary OpenModelAttribute
| Provides the constituent VLDs. Cardinality of 0 means that the NS is a NF set with unspecified connectivity. | |
_vnfdId | 0..* | Preliminary OpenModelAttribute
PassedByReference | References the VNFD of a constituent VNF. | |
_pnfdId | 0..* | Experimental OpenModelAttribute
PassedByReference | References the PNFD of a constituent PNF. |
NSVirtualLinkDesc - Network Service Virtual Link Descriptor
The NsVirtualLinkDesc class provides general information enabling the instantiation of virtual links. For all attributes in this class the Producer is SDC and the Consumer is SDC/UUI/VFC.
Parent class: VirtualLinkDesc
Applied stereotypes:
- Preliminary
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
vitualLinkDescProvider | String | 0..1 | Preliminary OpenModelAttribute
| Defines the organization generating the VLD. |
virtuaLinkDescVersion | Version | 1 | Preliminary OpenModelAttribute
| Specifies the version of the VLD. |
virtualLinkDf | 1 | Preliminary OpenModelAttribute
| Specifies properties for instantiating a VL according to a specific flavour. | |
virtualLinkDescId | Identifier | 1 | Preliminary OpenModelAttribute
| Uniquely identifies a VLD in the parent descriptor. For VnfVirtualLinkDesc, the parent descriptor is the VNFD. For NsVirtualLinkDesc, the parent descriptor is the NSD. Note: the description of this class are different in ETSI GS NFV IFA 011 and ETSI GS NFV IFA 014. The present definition merges the 2 definitions. |
connectivityType | 1 | Preliminary OpenModelAttribute
| Specifies the protocol exposed by a VL and the flow pattern supported by the VL. | |
description | String | 0..1 | Preliminary OpenModelAttribute
| Provides human-readable information on the purpose of the VL (e.g. control plane traffic). |
| Vnfd | Association | 0..* to 0..* | Preliminary OpenModelAttribute
| Vnfd binds to an NS Virtual Link Descriptor via VNF external CPs. VNF extenrnal CPs are exposed to NSD via VNFD |
Pnfd | Association | 0..* to 0..* | Experimental OpenModelAttribute
| PNFD binds to an NS Virtual Link Descriptor via PNF external CPs. PNF extenrnal CPs are exposed to NSD via PNFD |
Vnfd - VNF Descriptor
See VNFD Model
Attribute Name | Type | Mult. | Stereotypes | Description |
NSVirtualLinkDesc | Association | 0..* to 0..* | Preliminary OpenModelAttribute
| VNF binds to an NS Virtual Link Descriptor via VNF external CPs. VNF extenrnal CPs are exposed to NSD via VNF |
Pnfd - PNF Descriptor
Refer to PNF resource IM proposal
Attribute Name | Type | Mult. | Stereotypes | Description |
NSVirtualLinkDesc | Association | 0..* to 0..* | Preliminary OpenModelAttribute
| PNF binds to an NS Virtual Link Descriptor via PNF external CPs. PNF extenrnal CPs are exposed to NSD via PNF |
Datatypes
NsLifeCycleManagementScript
The LifeCycleManagementScript information element specifies a script for the NS.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
event | String | 1..* | RW | OpenModelAttribute
| Describes NS lifecycle event(s) or an external stimulus detected on an NFVO reference point. NOTE 1: A minimum set of NS lifecycle events triggered internally by the NFVO includes: start instantiation, end instantiation, start scaling, end scaling, start healing, end healing, start termination, end termination, start update, end update. NOTE 2: A minimum set of external stimulus includes: the receipt of request message of instantiation, scaling, healing, termination, update of NS. |
script | String | 1 | RW | OpenModelAttribute
| Includes an NS LCM script (e.g., written in a DSL) triggered to react to one of the events listed in the event attribute. |
VirtualLinkDf
The VirtualLinkDf datatype specifies properties for instantiating a VL according to a specific flavour.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
flavourId | Identifier | 1 | RW | Preliminary OpenModelAttribute
| Identifies this VirtualLinkDF datatype within a VLD. |
qos | 0..1 | RW | Preliminary OpenModelAttribute
| Specifies quality of service parameters applicable to a VL. | |
serviceAvaibilityLevel | Enum | 0..1 | RW | Preliminary OpenModelAttribute
| Specifies one of the three levels defined in ETSI GS NFV-REL 001: • Level 1 • Level 2 • Level 3 |
ConnectivityType
The ConnectivityType datatype specifies the protocol exposed by a VL and the flow pattern supported by the VL.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
layerProtocol | Enum | 1 | RW | OpenModelAttribute
| Identifies the protocol this VL gives access to ( |
flowPattern | String | 0..1 | RW | OpenModelAttribute
| Identifies the flow pattern of the connectivity (Line, Tree, Mesh). |
NsQos
The NsQoS datatype specifies quality of service parameters applicable to a NS VL.
Parent Datatype: QoS
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
priority | Integer | 0..1 | RW | Preliminary OpenModelAttribute
| Specifies the priority level in case of congestion on the underlying physical links. |
latency | Number | 1 | RW | Preliminary OpenModelAttribute
| Maximum latency in ms. |
packetDelayVariation | Number | 1 | RW | Preliminary OpenModelAttribute
| Maximum jitter in ms. |
packetLossRatio | Number | 0..1 | RW | Preliminary OpenModelAttribute
| Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists. |
Enumerations
ServiceAvailabilityLevel
Specifies one of the three levels defined in ETSI GS NFV-REL 001: • Level 1 • Level 2 • Level 3
Contains Enumeration Literals:
- LEVEL_1
- LEVEL_2
- LEVEL_3
LayerProtocol
Identifies the protocol this VL gives access to (IPV4, IPV6)
Contains Enumeration Literals:
- IPV4
- IPV6
Primitives
Number
This primitive type is a superset of the standard UML numbering primitives, e.g. Integer and Real.
Version
This primitive type defines the version of an element.