Page History

...

SDC (Service)	AAI (service)	ECOMP IM (ServiceCatalogItem)	Comments	Confirmed	Description
invariantUUID				serviceInvariantUUID	Constant identifier of the service model
UUID	service-id	ServiceUUID		serviceUUID	Versioned identifier of the service model (this uuid is changed for every major version of the service)
name		ServiceDisplayName		serviceName	The name of the service
description	service-description	ServiceDescription		serviceDescription	The description of the service Visible when the user hovers over this service in the design studio UI.
type			ServiceCatalogItem-Q1: what‘s the difference of type and serviceType or category?’ Category - A predefined list which identifies the construct's category. There is a predefined list of service categories and resource categories. Type - A predefined list which identifies the construct (i.e., service, VF, VFC, CP, VL, etc.). serviceType - An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.		A predefined list which identifies the construct (i.e., service, VF, VFC, CP, VL, etc.).
Category		Category			A predefined list which identifies the construct's category. There is a predefined list of service categories and resource categories. Designer cannot define new Category. Process required to add/change/delete
serviceType	serviceType				An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.
serviceRole	serviceRole		ServiceCatalogItem-Q2: What's the ServiceRole used for in the use cases and how does it effect the run-time components? serviceRole - An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.		An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.
serviceEcompNaming			ServiceCatalogItem-Q3: What's the naming used for in the use cases and how does it effect the run-time components? The naming fields are used to define if the service instance name is auto-generated by the runtime components (SO and SDNC). Need to refer to the use case owners to understand if and how these fields are used.
ecompGeneratedNaming
namingPolicy
service_naming
	service-version	Version		serviceVersion	The service version in SDC catalog
	resource-version		@ James Forsyth: ServiceCatalogItem-Q4: The version of resource are related to the resource. One service may is composed of many resources, which may have different versions. Which version of the resources are set in the service?		resource-version for concurrency
		AT&TContact	@Andy Mayer : ServiceCatalogItem-Q5: Is it the service designer? If consider multi-designers, the attributes should be array type.		This is the technology owner. ATT UID. Future click on UID and launch mail client. Multiple contacts should be supported.
		Capacity	@Andy Mayer : ServiceCatalogItem-Q6: Please clarify what it is. How is it effects the design time and run-time?		Obtain from vendor if available; tester can add additional information
		Constraints	@Andy Mayer : ServiceCatalogItem-Q7: The constraints is not an independent attribute, and is a constraint within the attribute definition. right?		From the TOSCA model. Multiple fields. Could include thresholds and policies. Vendor upgrade requirements should also be included here.
		Cost	@ Andy Mayer : ServiceCatalogItem-Q8: Please clarify what it is. How is it effects the design time and run-time?		2015: will be blank and not mandatory. 2016 may be accessed by role (TBD) and will be a mandatory field.
		D2RequirementsChecklist	@Andy Mayer ServiceCatalogItem-Q9: What's the Cost used for in the use cases and how does it effect the run-time components?		Spreadsheet with input constraints, entries will be searchable
		EntitlementID	@Andy Mayer ServiceCatalogItem-Q10: In the latest document there is no entitlement. is it obsoleted?		Composite ID of contract and entitlement number from myprocurement
		EntitlementUnitNumber			From contract/entitlement
		EntitlementUnitType			From contract/entitlement
		FaultRequirements	@Andy Mayer ServiceCatalogItem-Q11: It is an document from vendor. Should it be managed in the ONAP?		Obtain from vendor
		Features	@Andy Mayer ServiceCatalogItem-Q11: It is an document from vendor. Should it be managed in the ONAP?		Obtain from vendor
		History	@Andy MayerServiceCatalogItem-Q13: the type is only char. It is not enough to support the function as described.		Keeping all major events, i.e., creation date, any modification, check in and check out with ATT UID.
		Icon		icon	The icon path of the service Process required to add new icon.
		LicensingModel	@Andy MayerServiceCatalogItem-Q14: Do the Service support license? Could you give some details about it?		Multiple fields. Categories of licenses planned; type, unit.
		Performance	@Andy Mayer ServiceCatalogItem-Q11: It is an document from vendor. Should it be managed in the ONAP?		Obtain from vendor if available; tester can add additional information
		Requirements	@Andy Mayer ServiceCatalogItem-Q11: It is an document from vendor. Should it be managed in the ONAP?		Multiple fields. Includes connectivity
		ServiceSystemName	@Andy Mayer It is not like an service attribute. Please clarify why displayed in the design studio.		This field will be used in URLs and not exposed in create service UI; will be displayed in design studio. Meaningful service name used in API. The system name is used in the distribution studio (distribution notification and distribution API). - Max length of 25 characters - Allowed characters: alphanumeric, underscore, dash, dot. - Autocreated based upon the Service Display Name: spaces are trimmed, each word starts with a capital letter, on the first letter of abbreviation and acronyms are capitalized. - If the Service Display name changes, the Service System name will automatically be updated. - Service System name is not editable by the designer. - Name must be unique and is searchable.
		Subcategory			Flat list in 1507. In 1510, UI will be separated to different field from Category.
		Tags/Keywords			Must accept multiple keywords
		Template	@Andy Mayer is it the service Templates?		Need to define a list of templates. Tied to Category. Designer cannot create new template (must be created by development team). Process required to add/change/delete. Could consider designer ability to create / modify template in 1602.
		TestScripts
		VendorTestResults	@Andy Mayer It is an document from vendor. Should it be managed in the ONAP?
		VF-SpecificPolicies	@Andy Mayer should be those VF related attributes moved to VNF, not in the service?		Part of the lifecycle management of the artifact.
		VFArtifacts			Artifact name stored in Swift. Artifacts are searchable / indexable.
		VFConfigParameters			Scripts are an artifact, this may be redundant
		VFImage			URL to file stored in Glance or Swift, depending upon image vs. binary

...

ServiceComponentCatalogItem

SDC (Service)	AAI (service)	ECOMP IM (ServiceComponentCatalogItem)	ETSI IFA014 (NetworkService)	Comments	Confirmed	Description
invariantUUID			nsdInvariantId		invariantUUID	Constant identifier of the Service Component model
UUID	service-id	ServiceComponentCatalogItem	nsdIdentifier		UUID	Versioned identifier of the Service Component model (this uuid is changed for every major version of the service component)
name			nsdName		name	The name of the service component
description	service-description				description	The description of service component
type				same with the ServiceCatalogItem-Q1 same with the ServiceCatalogItem-Q2		A predefined list which identifies the construct (i.e., service, VF, VFC, CP, VL, etc.).
Category						A predefined list which identifies the construct's category. There is a predefined list of service categories and resource categories. Designer cannot define new Category. Process required to add/change/delete
serviceType	serviceType					An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.
serviceRole	serviceRole					An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.
serviceEcompNaming				same with the ServiceCatalogItem-Q3
ecompGeneratedNaming
namingPolicy
service_naming
	service-version		version		version	The version of service component
	resource-version			same with the ServiceCatalogItem-Q4		resource-version for concurrency
			designer		designer	The designer of service component

ServiceComponent - Network Service Descriptor
Inherit from ServiceComponentCatalogItem

ETSI IFA014 (NetworkService)	Confirmed Attributes	Description
vnfdid	vnfdid

nestedNsdId

References the

NSD

VNFD of a constituent

nested NS

VNF.

ResourceCatalogItem

pnfdId

vnfdid

pnfdId

References the

VNFD

PNFD of a constituent

VNF

PNF.

ResourceCatalogItempnfdId

virtualLinkDesc	virtualLinkDesc	Provides the constituent VLDs.
nestedNsdId		References the

PNFD

NSD of a constituent

PNF

nested NS.
sapd		Provides the descriptor of a service access point of the network service.

ResourceCatalogItemvirtualLinkDescProvides the constituent VLDs.

vnffgd

Provides the descriptors of the

applicable forwarding graphs.
monitoredInfo		Identifies either a virtualised resourcerelated

performance metric or a VNF

Indicator.
autoScalingRule		Specifies a rule to trigger a scaling action on a NS instantiated according to the NSD.
lifeCycleManagementScript		Provides a life cycle management

script written in a Domain Specific Language (DSL).
nsDf		Identifies a DF within the scope of an NSD.
security		Provides a signature to prevent

tampering.

Network
ServiceComponent - WAN Service Descriptor
Inherit from ServiceComponentCatalogItem

...

References the VNFD of a constituent VNF.

...

References the PNFD of a constituent PNF.

...

TBD

ServiceComponentInstance

AAI (ServiceInstance)	ECOMP IM (service component)	ETSI IFA013 (NS)	Comments	Confirmed	Descripion
service-Instance-Id		nsInstanceId		componentInstanceId	Uniquely identifies this instance of a service component
service-instance-name		nsName		componentInstanceName	The name assigned to the service component instance
service-type			maopeng zhang same with the ServiceCatalogItem-Q1 same with the ServiceCatalogItem-Q2		An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.
service-role					An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.
environment-Context			maopeng zhang same with the ServiceInstance-Q1		This field will store the environment context assigned to the service-instance
workload-Context			maopeng zhang same with the ServiceInstance-Q2		This field will store the workload context assigned to the service-instance.
model-invariant-id		nsdId		invariantUUID	Constant identifier of the service component model
model-version-id

...

ServiceComponentInstance

AAI
(ServiceInstance)

ECOMP IM

(service component)

ETSI IFA013

(NS)

CommentsConfirmedDescripionservice-Instance-IdnsInstanceIdcomponentInstanceIdUniquely identifies this instance of a service componentservice-instance-namensNamecomponentInstanceName
The name assigned to the service component instanceservice-type

maopeng zhang

same with the

ServiceCatalogItem

ServiceInstance-

Q1

same with the ServiceCatalogItem-Q2

An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.service-roleAn optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.environment-Context

Q3		Versioned identifier of the service component model (this uuid is changed for every major version of the service component)
Q3	persona-Model-Version			The service version in SDC catalog
widget-Model-Id			maopeng zhang same with the ServiceInstance-Q4	the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-Model-Version			maopeng zhang same with the ServiceInstance-Q4	the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
bandwidth-total			maopeng zhang same with the ServiceInstance-

Q1
This field will store the environment context assigned to the service-instanceworkload-Context

maopeng zhang

same with the ServiceInstance-Q2

This field will store the workload context assigned to the service-instance.model-invariant-idnsdIdinvariantUUIDConstant identifier of the service component modelmodel-version-id

maopeng zhang

same with the ServiceInstance-Q3
Versioned identifier of the service component model (this uuid is changed for every major version of the service component)persona-Model-VersionThe service version in SDC catalogwidget-Model-Id

maopeng zhang

same with the ServiceInstance-Q4

the ASDC data dictionary widget model. This maps directly to the A&AI widget.widget-Model-Versionthe ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.bandwidth-total

maopeng zhang

same with the ServiceInstance-Q5

Indicates the total bandwidth to be used for this service.bandwidth-up-wan1indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.bandwidth-down-wan1indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.bandwidth-up-wan2indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.bandwidth-down-wan2indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.vhn-portal-urlURL customers will use to access the vHN Portal.service-instance-location-idAn identifier that customers assign to the location where this service is being used.resource-versionresource-version for concurrencselflinkselfLinkURL to endpoint where more details can be gottenorchestration-statusnsStatestatusOrchestration status of the service component instancedescriptiondescriptionThe description of service component instance

Network Service Instance

Inherit from ServiceComponentInstance

ETSI IFA013

(NS)

ConfirmedDescripionvnfInfoIdvnfInfoIdReference to information on constituent VNFs of this NS.pnfInfopnfInfo

Information on the PNF(s) that are part of this NS.

virtualLinkInfovirtualLinkInfo

Information on the VLs of thisNS.

flavourIdReference to the flavour of the NSD used to instantiate this NS.vnffgInfoInformation on the VNFFGs of this NS.sapInfoInformation on the SAPs of this NS.nestedNsInfoIdReference to information on nested NSs of this NS.nsScaleStatusRepresents for each NS scaling aspect declared in the applicable DF, how "big" the NS instance has been scaled w.r.t. that aspect.additionalAffinityOrAntiAffinityRuleInformation on the additional affinity or anti-affinity rule from NS instantiation operation. Shall not conflict with rules already specified in the NSD.WAN Service Instance

ExternalVirtualLink Description

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.

Q5		Indicates the total bandwidth to be used for this service.
	bandwidth-up-wan1			indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
	bandwidth-down-wan1			indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
	bandwidth-up-wan2			indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
	bandwidth-down-wan2			indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
	vhn-portal-url			URL customers will use to access the vHN Portal.
service-instance-location-id				An identifier that customers assign to the location where this service is being used.
resource-version				resource-version for concurrenc
selflink			selfLink	URL to endpoint where more details can be gotten
orchestration-status		nsState	status	Orchestration status of the service component instance
		description	description	The description of service component instance

ServiceComponent Instance - Network Service

Inherit from ServiceComponentInstance

ETSI IFA013 (NS)	Confirmed	Descripion
vnfInfoId	vnfInfoId	Reference to information on constituent VNFs of this NS.
pnfInfo	pnfInfo	Information on the PNF(s) that are part of this NS.
virtualLinkInfo	virtualLinkInfo	Information on the VLs of thisNS.
flavourId		Reference to the flavour of the NSD used to instantiate this NS.
vnffgInfo		Information on the VNFFGs of this NS.
sapInfo		Information on the SAPs of this NS.
nestedNsInfoId		Reference to information on nested NSs of this NS.
nsScaleStatus		Represents for each NS scaling aspect declared in the applicable DF, how "big" the NS instance has been scaled w.r.t. that aspect.
additionalAffinityOrAntiAffinityRule		Information on the additional affinity or anti-affinity rule from NS instantiation operation. Shall not conflict with rules already specified in the NSD.

ServiceComponent Instance - WAN Service

TBD

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 Instance

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-statusstatusnslinkport

Space shortcuts

Page tree

Versions Compared

Old Version 27

New Version 28

Key

ServiceComponentCatalogItem

ServiceComponent - Network Service Descriptor

ServiceComponent - WAN Service Descriptor

ServiceComponentInstance

ServiceComponentInstance

Network Service Instance

ExternalVirtualLink Description

ServiceComponent Instance - Network Service

ExternalVirtualLink Instance