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

UML Comparison

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

• Run Time Model (VNF Instance)

  1) ECOMP IM (vNF deployment diagram)
  
  Questions:
    - What's the relationship between VNFC instance and VNF module? What's the usage of VNF module?
    - Why does network only associate with the VM, but not with Docker/LXC? Why is the cardinality 1:1?
    - Why does storage have no association with VNFC instance?
    - Why does VNFImage have 1:1 association with VNF instance, instead of VNFC instance?
    - No model for network port?
  
  Is the VNF Instance model still under discussion like the VNFD model?
  
  2) ETSI IFA IM (IFA015 VNFLogicalModel diagram)
  

• Design Time Model

  1) ONAP Resource Model UML
  
  

• 
  
  2) ETSI IFA IM (IFA015 VNFD)
  
  (besides VduCpd, Vdu also has relationship with VirtualComputeDesc, VirtualStorageDesc and swImageDesc; which are omitted in this diagram)
  
  3) SDC IM (normative and heat types)
  

(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

  AAI (aai_schema_v11 vnfc)	ECOMP IM (VNFC Instance)	ETSI IFA008 (VnfcInfo)	Comment	Description
  vnfc-name		vnfcInstanceId		identifier of the vnfc instance
  nfc-naming-code			Xu: Need specification/reference for the value of this attribute? Xu: Should the attribute name aligned to "vnfc"?	short code of the vnfc instance
  nfc-function			Xu: Should the attribute name aligned to "vnfc"?	description of the vnfc instance
  prov-status			Xu: need further clarification on how this attribute is used	Trigger for operational monitoring of this resource by Service Assurance systems
  orchestration-status		vnfcState	Xu: Is it the same as vnfcState (i.e., start or stop)?	Orchestration status of this VNF, mastered by APP-C
  ipaddress-v4-oam-vip			Xu: Is this attribute mandatory? and applicable for all kinds of VNFCs?	Oam V4 vip address of this vnfc
  in-maint				whether in maintenance mode
  is-closed-loop-disabled			Xu: used by DCAE?	used to indicate whether closed loop function is enabled on this node
  group-notation			Xu: need further clarification on how this attribute is used	Group notation of VNFC
  model-invariant-id		vduId		the SDC model id for this resource model
  model-version-id				the SDC model version for this resource model
  resource-version			Xu: Is it used internally in AAI? can be omitted in the general model.	Used for optimistic concurrency.  Must be empty on create, valid on update and delete
  l3-interface-ipv4-address-list				l3 interface addresses, ipv4
  l3-interface-ipv6-address-list				l3 interface addresses, ipv6
  relationship-list	association (VM, Docker, LXC)			AAI: relationship with vserver, vf-module and generic-vnf

• VNFC Design Time Model

  SDC (abstract.nodes.VFC)	ECOMP IM (VNFCCatalogItem)	ETSI IFA011 (VDU/VduProfile)	Comment	Description
  Nfc_function		description	Xu: Should the attribute name aligned to "vdu"?	description of the vdu
  High_availability				An optional String property that indicates the high_availability functionality of this VFC (e.g. “geo-activeactive”)
  Vm_image_name		swImageDesc	Xu: not fully aligned, need to analysis which information need to be exposed	Name or information of the software image used by the vdu.
  Vm_flavor_name				An optional String property that provides the vm flavor name
  Nfc_naming_code			Xu: aligned with AAI model	Mandatory String property that describes the role of the VFC in the VF context. E.g. Signaling Session Controller (SSC), Media Session Controller (MSC)
  Vm_type_tag				Mandatory String property that indicates the vm-type as was defined by vendor
  Nfc_naming		name		name of the vdu
  Min_instances		minNumberOfInstances		minimal amount of the VNFC instances allowed to be instantiated in the containing VNF instance
  Max_instances		maxNumberOfInstances		maximum amount of the VNFC instances allowed to be instantiated in the containing VNF instance
  UUID		vduId		identifier of the model
  (other metadata attributes)				version of the model, type of the model, category/subcategory, ...
  	association (VNFCConfiguration, VNFCCapability)
  		intCpd		Describes network connectivity between a VNFC instance (based on this Vdu) and an internal Virtual Link (VL).
  		virtualComputeDesc		Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu.
  		virtualStorageDesc		Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from virtualComputeDesc defined for this Vdu.
  		bootOrder		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.
  		nfviConstraint		Describes constraints on the NFVI for the VNFC instance(s) created from this Vdu.
  		monitoringParameter		Defines the virtualised resources monitoring parameters on VDU level.
  		configurableProperties		Describes the configurable properties of all VNFC instances based on this VDU.
  		localAffinityOrAntiAffinityRule		Specifies affinity or anti-affinity rules applicable between the virtualisation containers (e.g. virtual machines) to be created based on this VDU.
  		affinityOrAntiAffinityGroupId		Identifier(s) of the affinity or anti-affinity group(s) the VDU belongs to.

• VNF Run Time Model

  AAI (generic_vnf)	ECOMP IM (VNF instance)	ETSI IFA007 (VnfInfo)	Comment	Description
  vnf-id		vnfInstanceId		identifier of the vnf instance
  vnf-name		vnfInstanceName		name of the vnf instance
  vnf-name2			Xu: use case for alternative name?	alternative name of the vnf instance
  vnf-type	VFType		Xu: Is there any reference/specification for the value of this attribute?	String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
  service-id			Xu: deprecated?	Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
  regional-resource-zone				Regional way of organizing pservers, source of truth should define values
  prov-status			Xu: Need clarification, similar to vnfc instance model.	Trigger for operational monitoring of this resource by Service Assurance systems.
  operational-status			Xu: Need clarification on how this attribute is used.	Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
  license-key			Xu: deprecated?	OBSOLETE -  do not use
  equipment-role			Xu: Please clarify the usage of this attribute.	Client should send valid enumerated value
  orchestration-status			Xu: only used by SO?	Orchestration status of this VNF, used by MSO.
  heat-stack-id			Xu: only used by SO?	Heat stack id corresponding to this instance, managed by MSO
  mso-catalog-key			Xu: only used by VCE?	Corresponds to the SDN-C catalog id used to configure this VCE
  management-option			Xu: Need clarification on how this attribute is used.	identifier of managed by ATT or customer
  ipv4-oam-address			Xu: Is this attribute mandatory? and applicable for all kinds of VNFs? (same question as VNFC instance model)	Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
  ipv4-loopback0-address			Xu: same as above	v4 Loopback address
  nm-lan-v6-address			Xu: same as above	v6 Loopback address
  management-v6-address			Xu: same as above	v6 management address
  vcpu			Xu: only used by uCPE?	number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
  vcpu-units			Xu: only used by uCPE?	units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
  vmemory			Xu: only used by uCPE?	number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
  vmemory-units			Xu: only used by uCPE?	units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
  vdisk			Xu: only used by uCPE?	number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
  vdisk-units			Xu: only used by uCPE?	units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
  in-maint				indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs
  is-closed-loop-disabled				indicate whether closed loop function is enabled on this node
  resource-version			Xu: Is it used internally in AAI? can be omitted in the general model.	Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
  summary-status			Xu: deprecated?	details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
  encrypted-access-flag				indicates whether generic-vnf access uses SSH
  entitlement-assignment-group-uuid			Xu: deprecated?	UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
  entitlement-resource-uuid			Xu: deprecated?	UUID of the specific entitlement resource.  OBSOLETE -  See child relationships
  license-assignment-group-uuid			Xu: deprecated?	UUID of the license assignment group.  OBSOLETE -  See child relationships.
  license-key-uuid			Xu: deprecated?	UUID of the actual license resource.  OBSOLETE -  See child relationships.
  model-invariant-id	VNF Model Id	vnfdId		identifier of the VNF model
  model-version-id	VNF Model Version	vnfdVersion		version of the VNF model
  persona-model-version			Xu: It seems to be used internally in AAI, need clarification on the usage of this attribute.	the ASDC model version for this resource or service model
  model-customization-id		vnfConfigurableProperty		captures the id of all the configuration used to customize the resource for the service
  widget-model-id			Xu: Is it used internally in AAI? Can be omitted in general model	the ASDC data dictionary widget model. This maps directly to the A&AI widget.
  widget-model-version			Xu: Is it used internally in AAI? Can be omitted in general model	the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
  as-number			Xu: Please clarify the usage of this attribute.	as-number of the VNF
  regional-resource-subzone				Regional way of organizing pservers, source of truth should define values
  nf-type			Xu: What's the difference between vnf-type and nf-type?	Generic description of the type of NF
  nf-function		vnfInstanceDescription		description of the VNF instance
  nf-role	NetworkRole			role in the network that this model will be providing
  nf-naming-code				string assigned to this model used for naming purposes
  selflink			Xu: what controller?	Path to the controller object
  ipv4-oam-gateway-address			Xu: Is this attribute mandatory? and applicable for all kinds of VNFs?	Gateway address
  ipv4-oam-gateway-address-prefix-length			Xu: same as above	Prefix length for oam-address
  vlan-id-outer			Xu: only used by VCE?	Temporary location for S-TAG to get to VCE
  nm-profile-name				Network Management profile of this VNF
  relationship-list			Xu: Is the description correct?	relationship with l-interface, availability-zone, lag-interface, l3-network, pserver, vserver, service-instance, vf-module, volume-group, vnfc and logical-link
  l-interfaces				logical interfaces
  lag-interfaces				Collection of link aggregate interfaces
  vf-modules				a deployment unit of VNFCs
  licenses				license information
  entitlements				entitlement information
  	HomingPolicy			Reference to VNF-level homing policy that ECOMP will use when VNF deployment target node is auto-selected
  	TargetNodePrompt			"Y" indicates operator-supplied VNF instance target deployment node required. Present prompt to operator: "Enter target node for deployment of this VNF instance" "N" indicates that the target deployment node for this VNF instance will be auto-selected by ECOMP
  	VLAN Range Plan			Identifies the VNF-level VLAN Range Plan that must be used by ECOMP to assign VLAN tags to an instance of this VNF type
  	VNF Name Prompt			"Y" indicates operator-supplied VNF name required. Present prompt to operator: "Enter the name for this VNF instance" "N" indicates that the name for the VNF instance will be auto-generated by ECOMP
  	VNF Naming Policy			Reference to VNF-level naming policy that ECOMP will use when VNF-level name is auto-generated
  	VNF Network Tag			Must correlate to the set of defined “network-role” identifiers from the associated HEAT templates
  		vnfSoftwareVersion		Software version of the VNF. This is changed when there is any change to the software that is included in the VNF Package.
  		vnfProvider		Provider of the VNF and of the VNFD.
  		vnfProductName		Name to identify the VNF Product. Invariant for the VNF Product lifetime.
  		onboardedVnfPkgInfoId		Identifier of the specific VNF Package on which the VNF is based.
  		instantiationState		The instantiation state of the VNF instance. Possible values: NOT_INSTANTIATED (VNF instance is terminated or not instantiated, and the identifier of the VNF instance exists), INSTANTIATED (VNF instance is instantiated).
  		instantiatedVnfInfo		Information specific to an instantiated VNF instance. Shall be present if the VNF is in INSTANTIATED instantiation state.
  		metadata		Additional VNF-specific metadata describing the VNF instance.
  		extension		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)	Comment	Description
  Nf_function	description	vnfProductInfoDescription		description of the VNF model
  Nf_role				Mandatory property for short code that defines a Network function that the Vendor Software or PNF  is providing. E.g. vCE, vARM
  Nf_naming_code	short-name			Mandatory 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_type				Mandatory 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_naming	name	vnfProductName		name of the VNF
  		vnfProductInfoName		Human readable name for the VNF Product. Can change during the VNF Product lifetime.
  Availability_zone_max_count			Xu: 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 2
  Min_instances				An optional property declaring the minimum number of this VF in the Service
  Max_instances				An optional property declaring the maximum number of this VF in the Service
  UUID	id	vnfdId		identifier of the VNF model
  	logo			logo
  	vendor	vnfProvider		Provider of the VNF and of the VNFD.
  version	version	vnfdVersion		version of the VNF model
  		vnfSoftwareVersion		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).
  		defaultLocalizationLanguage		Default localization language
  		vdu		Virtualisation Deployment Unit. VNFC model
  		virtualComputeDesc		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: 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