This page is used for the ONAP R2+ Resource IM drafting and discussion.

Current Resource Information Model UML Documentation: ONAP Resource 2017-11-08.docx

...

Content:

• UML Comparison
  • Run Time Model
  • Design Time Model
• Attribute Comparison
  • VNFC Run Time Model
  • VNFC Design Time Model
  • VNF Run Time Model
  • VNF Design Time Model

...

UML Comparison

This section illustrates the core IM design related to VNF resource from different sources.  

...

Run Time Model (VNF Instance)

...

IFA015, VNF Classes Mapping

Image Removed

Michela Bevilacqua: How do we map VNFInfo, InstantiatedVnfInfo and connected Info classes present in IFA015 to ONAP IM ?

Design Time Model

...

Image Removed

...

Michela Bevilacqua: Resource Model Design Time: ETSI IFA015 - ONAP IM  R1.0 comparison:

1) In IFA011  the relation between Vdu and VnfDf has a cardinality 1..N while in ONAP is defined an association with a cardinality 0..*. Is it possible to align ONAP IM with IFA011?

Resource Model Real Time:

1) Controller modelling:

...

(omit several types for simplicity)

...

Attribute Comparison

This section compares the different IM design from different sources.

Sources:

• AAI: aai_schema_v11
• ECOMP: ECOMP AID
• SDC: SDC current ECOMP model
• ETSI: IFA007, IFA008, IFA011

...

VNFC Run Time Model

...

References:

• AAI: aai_schema_v11 vnfc)
• ECOMP IM (VNFC Instance)ETSI IFA008 (VnfcInfo)CommentDescriptionvnfc-namevnfcInstanceIdidentifier of the vnfc instancenfc-naming-code

  Xu Yang: Need specification/reference for the value of this attribute? Xu Yang: Should the attribute name aligned to "vnfc"?

  James Forsyth: No, in a network function we should not care if it's physical or virtual

  short code of the vnfc instancenfc-function

  Xu Yang: Should the attribute name aligned to "vnfc"?
  James Forsyth No, in a network function we should not care if it's physical or virtual
  

  description of the vnfc instanceprov-status

  Xu Yang: need further clarification on how this attribute is used
  James Forsyth: Service assurance systems use this status in their logic to determine the provisioning status.  Values such as: PROVISIONED, PREPROVISIONED, CAPPED might be stored in this attribute

  Trigger for operational monitoring of this resource by Service Assurance systemsorchestration-statusvnfcState

  Xu Yang: Is it the same as vnfcState (i.e., start or stop)?
  James Forsyth: Used for lifecycle management.  We don't know what vnfcState is.

  Xu Yang: vnfcState describes the state of a VNFC instance, possible values are: STARTED, STOPPED. STARTED means the VNFC instance is up and running, and STOPPED means the VNFC instance has been shut down (but not terminated/deleted). Similar to the VM power on/off concept.

  Orchestration status of this VNF, mastered by APP-Cipaddress-v4-oam-vip

  Xu Yang: Is this attribute mandatory? and applicable for all kinds of VNFCs?
  James Forsyth: Not mandatory and this field should be deprecated in ONAP

  Oam V4 vip address of this vnfcin-maint

  Pamela Dragosh: DCAE monitors this flag. If set it does not "observe" alarms/traps/etc. during control loop.

  whether in maintenance modeis-closed-loop-disabled

  Xu Yang: used by DCAE?
  James Forsyth: There are closed loop actions that DCAE might have policies for, and operations can turn off those actions with this flag

  Pamela Dragosh: Yes actually Policy has the rules that check for this. DCAE does not. DCAE does however check the in-maint flag.

  used to indicate whether closed loop function is enabled on this nodegroup-notation

  Xu Yang: need further clarification on how this attribute is used
  James Forsyth: In some applications, a two or more VMs or VNFCs is referred to by a name, and group-notation represents the name.  Might want to use instance-group to replace this over time.
  

  Group notation of VNFCmodel-invariant-idvduIdthe SDC model id for this resource modelmodel-version-idthe SDC model version for this resource modelresource-version

  Xu Yang: Is it used internally in AAI? can be omitted in the general model.
  James Forsyth: It's used internally in AAI to enforce concurrency control, other systems use it to pass to AAI on updates and delete operations.  It can be omitted from the general model
  

  Used for optimistic concurrency.  Must be empty on create, valid on update and deletel3-interface-ipv4-address-listl3 interface addresses, ipv4l3-interface-ipv6-address-listl3 interface addresses, ipv6relationship-listassociation (VM, Docker, LXC)AAI: relationship with vserver, vf-module and generic-vnf

...

VNFC Design Time Model

...

...

...

...

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

...

Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu.

...

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

...

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.

...

Describes constraints on the NFVI for the VNFC instance(s) created from this Vdu.

...

Defines the virtualised resources monitoring parameters on VDU level.

...

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

...

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

...

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

...

VNF Run Time Model

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

relationship with l-interface, availability-zone, lag-interface, l3-network, pserver, vserver, service-instance, vf-module, volume-group, vnfc and logical-link

...

"Y" indicates operator-supplied VNF instance target deployment node required. Present prompt to operator: "Enter target node for deployment of this VNF instance"

...

"Y" indicates operator-supplied VNF name required. Present prompt to operator: "Enter the name for this VNF instance"

...

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

...

Name to identify the VNF Product. Invariant for the VNF Product lifetime.

...

Identifier of the specific VNF Package on which the VNF is based.

...

Possible values: NOT_INSTANTIATED (VNF instance is terminated or not instantiated, and the identifier of the VNF instance exists), INSTANTIATED (VNF instance is instantiated).

...

Information specific to an instantiated VNF instance. Shall be present if the VNF is in INSTANTIATED instantiation state.

...

Additional VNF-specific metadata describing the VNF instance.

...

VNF-specific attributes that affect the lifecycle management of this VNF instance by the VNFM, or the lifecycle management scripts.

...

VNF Design Time Model

SDC (generic_VF)ECOMP IM (VNFCatalogItem)ETSI IFA011 (VNFD)CommentDescriptionNf_functiondescriptionvnfProductInfoDescriptiondescription of the VNF modelNf_roleMandatory property for short code that defines a Network function that the Vendor Software or PNF  is providing. E.g. vCE, vARMNf_naming_codeshort-nameMandatory string providing short code that is used in VNF, PNF, and VM instance naming.  The NF Code  can be the same value or a different value than the NF Role.Nf_typeMandatory String property defining a generic type (like category) of the VF. The value is regulated and should be from a list defined in ASDC.Nf_namingnamevnfProductNamename of the VNFvnfProductInfoName

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

Availability_zone_max_count

Xu Yang: need clarfication on how this attribute is used.

An optional integer of  availability zones count in the VF. Value should be either 0, 1 or 2Min_instancesAn optional property declaring the minimum number of this VF in the ServiceMax_instancesAn optional property declaring the maximum number of this VF in the ServiceUUIDidvnfdIdidentifier of the VNF modellogologovendorvnfProviderProvider of the VNF and of the VNFD.versionversionvnfdVersionversion of the VNF modelvnfSoftwareVersion

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

vnfmInfo

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

localizationLanguage

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

defaultLocalizationLanguageDefault localization languagevduVirtualisation Deployment Unit. VNFC modelvirtualComputeDesc

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

virtualStorageDesc

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

intVirtualLinkDesc

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

vnfExtCpd

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

deploymentFlavour

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

configurableProperties

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

modifiableAttributes

Describes the modifiable attributes of the VNF.

lifecycleManagementScript

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

elementGroup

Describes the associated elements (i.e. VDUs and/or VLs) of a VNFD for a certain purpose during VNF lifecycle management.

vnfIndicator

Xu Yang: Indicators are vendor-specified information which can indicate the VNF behaviour.

Declares the VNF indicators that are supported by this VNF.

autoScale

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).

• PNF Run Time Model

• PNF Design Time Model

• Network Run Time Model

• Network Design Time Model

• ExternalVirtualLink Design Time Mode

  SDC
  (extVL)AAI ECOMP IMETSI IFA014
  (virtualLinkDesc)CommentsConfirmedDescriptioninvariantUUIDinvariantUUIDConstant identifier of the external virtual linkUUIDvirtualLinkDescIdvldIdVersioned identifier of the external virtual linkcustomizationUUID

  maopeng zhang

  is the resource instance referred to the run-time resource instance? If it is in the run-time, why is it in the design time?

  Identifier of the resource instance (uuid of the specific use of the resource model in this service). This identifier is regenerated whenever a user makes a change on the resource instance.

  versionvirtuaLinkDescVersionversionThe version of the external virtual linknamenameThe name of the external virtual linkdescriptiondescriptionThe description of the external virtual linktypeThe type of resource. Resource type can be either VF, VFC, VFCMT, CP or VL.categoryCategory of the resourcesubcategorySub-category of the resourceresourceVendorspecifies the vendor providing this assetresourceVendorReleasespecifies the release version given by the vendor (no exact correlation to the version of the asset in the SDC catalog)resourceVendorModelNumber

  Metadata of resources (VFs, VFCs, PNF) will include new field resourceVendorModelNumber. The value for this field is the part number defined by the vendor, e.g. “MX960”.

  network_typenetwork_typespecifies the nature of the physical network in the underlying cloud infra-structure. Examples are flat, vlan, gre or vxlan. For flat and vlan types, physical_network should be provided too.network_roleUnique label that defines the role that this network performs.   example: vce oam network, vnat sr-iov1 networknetwork_scopeUniquely identifies the network scope. Valid values for the network scope   includes: VF - VF-level network. Intra-VF network which connects the VFCs (VMs) inside the VF. SERVICE - Service-level network. Intra-Service network which connects  the VFs within the service GLOBAL - Global network which can be shared by multiple servicesnetwork_technologyECOMP supported network technologynetwork_ecomp_namingnetwork_homingnetwork_assignmentsprovider_networknetwork_flowsvendorvitualLinkDescProvidervl_namesame with the nameip_versionip_versionThe IP version of the requested network.cidrcidrThe cidr block of the requested network.start_ipstart_ipThe IP address to be used as the 1st one in a pool of addresses derived from the cidr block full IP range.end_ipend_ipThe IP address to be used as the last one in a pool of addresses derived from the cidr block full IP range.gateway_ipgateway_ipThe gateway IP address.network_namenetwork_nameAn Identifier that represents an existing Network instance in the underlying cloud infrastructure - OR - be used as the name of the new created network.network_idnetwork_idAn Identifier that represents an existing Network instance in the underlying cloud infrastructure. This property is mutually exclusive with all other properties except network_name.segmentation_idsegmentation_idA segmentation identifier in the underlying cloud infrastructure (e.g., VLAN id, GRE tunnel id). If the segmentation_id is specified, the network_type or physical_network properties should be provided as well.physical_networkphysical_networkidentifies the physical network on top of which the network is implemented, e.g. physnet1. This property is required if network_type is flat or vlan. dhcp_enabled dhcp_enabledIndicates the TOSCA container to create a virtual network instance with or without a DHCP service.testAccessvirtualLinkDfConnectivityType
  (layerProtocol,flowPattern)security

  • ExternalVirtualLink Run Time Model

  AAI
  (l3-network)ECOMP IM

  ETSI IFA013

  (VirtualLink)

  CommentsConfirmedDescriptionnetwork-idnsVirtualLinkInstanceIdvirtualLinkInstanceIdnetwork-namedescriptiondescriptionnetwork-rolenetwork-technologyneutron-network-idResourceHandle
  (vimId,resourceProviderId,resourceId)is-bound-to-vpn service-idnsInstanceIdcomponentInstanceIdnetwork-role-instanceresource-versionorchestration-statusheat-stack-idmso-catalog-keycontrail-network-fqdnmodel-invariant-idinvariantUUIDmodel-version-idUUIDpersona-model-versionversionmodel-customization-idwidget-model-idwidget-model-versionphysical-network-nameis-provider-network is-shared-network is-external-network selflinkselfLinkoperational-statusstatusnslinkportUML documentation: ONAP Resource 2017-11-08.docx
• SDC: SDC current ECOMP model
• ETSI: IFA007, IFA008, IFA011, IFA015

Content: