This page is used for the ONAP R2+ Service IM drafting and discussion.
ONAP R2+ Service IM start from ECOMP Service IM model as below class diagram:
Products are made up of services (ServiceCatalogItems on the design side, ServiceInstances on the runtime side).
Services are made up of service components. A service component is not seen or known to products like SID ResourceFacingServices are not seen by products.
A ServiceComponent can be made up of ServiceComponents or resources.
Services can be composed of other Services and may be referred to as complex services.
the comparision table among ECOMP IM, SDC IM, ETSI NFV IFA, A&AI as below:
ServiceCatalogItem
SDC (Service) | AAI (service) | ECOMP IM (ServiceCatalogItem) | Comments |
invariantUUID | serviceInvariantUUID | ||
UUID | service-id | ServiceUUID | serviceUUID |
name | ServiceDisplayName | serviceName | |
description | service-description | ServiceDescription | serviceDescription |
type | maopeng zhang ServiceCatalogItem-Q1: what‘s the difference of type and serviceType or category?’ 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”. | ||
Category | Category | ||
serviceType | serviceType | ||
serviceRole | serviceRole | maopeng zhang 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”. | |
serviceEcompNaming | maopeng zhang 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. maopeng zhang: ServiceEcompNaming and ecompGeneratedNaming are two flags to indentify whether the ONAP service name auto-generated. For the user, there are too many parameters to be inputted if using this feature. could it be possible that if namingPolicy is provided and serviceName is empty, the ONAP will auto-generate service name? | ||
ecompGeneratedNaming | |||
namingPolicy | |||
service_naming | |||
service-version | Version | serviceVersion | |
resource-version | maopeng zhang ServiceCatalogItem-Q4: What's the resource-version meaning here? The version of resource are related to the resource. Why is it as a service attribute? | ||
AT&TContact | maopeng zhang ServiceCatalogItem-Q5: Is it the service designer? If consider multi-designers, the attributes should be array type. | ||
Capacity | maopeng zhang ServiceCatalogItem-Q6: Please clarify how to use the attribute in the run-time? | ||
Constraints | maopeng zhang ServiceCatalogItem-Q7: ECOMP IM: From the TOSCA model. Multiple fields. Could include thresholds and policies. Vendor upgrade requirements should also be included here. TOSCA: A constraint clause defines an operation along with one or more compatible values that can be used to define a constraint on a property or parameter’s allowed values when it is defined in a TOSCA Service Template or one of its entities. The constraints is not a attribute. | ||
Cost | maopeng zhang : what's the Cost? | ||
D2RequirementsChecklist | |||
EntitlementID | |||
EntitlementUnitNumber | |||
EntitlementUnitType | |||
FaultRequirements | |||
Features | |||
History | |||
Icon | |||
LicensingModel | |||
Performance | |||
Requirements | |||
ServiceSystemName | |||
Subcategory | |||
Tags/Keywords | |||
Template | |||
TestScripts | |||
VendorTestResults | |||
VF-SpecificPolicies | |||
VFArtifacts | |||
VFConfigParameters | |||
VFImage |
ServiceInstance
AAI (ServiceInstance) | ECOMP IM (service-instance) | Comments |
service-Instance-Id | serviceInstanceId | |
service-instance-name | serviceInstanceName | |
service-type | ServiceInstance-Q1: Is it the same with the SDC service? | |
service-role | ||
environment-Context | ||
workload-Context | ||
model-invariant-id | serviceInvariantUUID | |
model-version-id | ServiceInstance-Q2: is it the UUID in the SDC? | |
persona-Model-Version | ||
widget-Model-Id | ||
widget-Model-Version | ||
bandwidth-total | ||
bandwidth-up-wan1 | ||
bandwidth-down-wan1 | ||
bandwidth-up-wan2 | ||
bandwidth-down-wan2 | ||
vhn-portal-url | ||
service-instance-location-id | ||
resource-version | ||
selflink | SelfLink | |
orchestration-status | orchestrationStatus |
ServiceComponentCatalogItem
SDC (Service) | AAI (service) | ECOMP IM | ETSI IFA014 (NetworkService) | Comments |
invariantUUID | nsdInvariantId | nsdInvariantId | ||
UUID | service-id | ServiceComponentCatalogItem | nsdIdentifier | nsdIdentifier |
name | nsdName | nsdName | ||
description | service-description | description | ||
type | ||||
Category | ||||
serviceType | serviceType | |||
serviceRole | serviceRole | |||
serviceEcompNaming | ||||
ecompGeneratedNaming | ||||
namingPolicy | ||||
service_naming | ||||
service-version | version | version | ||
resource-version | ||||
designer | designer | |||
ServiceComponentCatalogItem | nestedNsdId | nestedNsdId | ||
ResourceCatalogItem | vnfdid | vnfdid | ||
ResourceCatalogItem | pnfdId | pnfdId | ||
sapd | ||||
ResourceCatalogItem | virtualLinkDesc | |||
vnffgd | ||||
monitoredInfo | ||||
autoScalingRule | ||||
lifeCycleManagementScript | ||||
nsDf | ||||
security |
ServiceComponentInstance
AAI (ServiceInstance) | ECOMP IM (service component) | ETSI IFA013 (NS) | Comments |
service-Instance-Id | nsInstanceId | nsInstanceId | |
service-instance-name | nsName | nsName | |
service-type | |||
service-role | |||
environment-Context | |||
workload-Context | |||
model-invariant-id | nsdId | nsdId | |
model-version-id | |||
persona-Model-Version | |||
widget-Model-Id | |||
widget-Model-Version | |||
bandwidth-total | |||
bandwidth-up-wan1 | |||
bandwidth-down-wan1 | |||
bandwidth-up-wan2 | |||
bandwidth-down-wan2 | |||
vhn-portal-url | |||
service-instance-location-id | |||
resource-version | |||
selflink | selflink | ||
orchestration-status | nsState | status | |
description | |||
flavourId | |||
vnfInfoId | |||
pnfInfo | |||
virtualLinkInfo | |||
vnffgInfo | |||
sapInfo | |||
nestedNsInfoId | |||
nsScaleStatus | |||
additionalAffinityOrAntiAffinityRule |
ExternalVirtualLink Description
SDC (extVL) | AAI | ECOMP IM | ETSI IFA014 (virtualLinkDesc) | Comments |
invariantUUID | ||||
UUID | virtualLinkDescId | |||
customizationUUID | ||||
version | virtuaLinkDescVersion | |||
name | ||||
description | ||||
type | ||||
category | ||||
subcategory | ||||
resourceVendor | ||||
resourceVendorRelease | ||||
resourceVendorModelNumber | ||||
network_type | ||||
network_role | ||||
network_scope | ||||
network_technology | ||||
network_ecomp_naming | ||||
network_homing | ||||
network_assignments | ||||
provider_network | ||||
network_flows | ||||
vendor | vitualLinkDescProvider | |||
vl_name | ||||
ip_version | ||||
cidr | ||||
start_ip | ||||
end_ip | ||||
gateway_ip | ||||
network_name | ||||
network_id | ||||
segmentation_id | ||||
physical_network | ||||
dhcp_enabled | ||||
testAccess | ||||
virtualLinkDf | ||||
ConnectivityType (layerProtocol,flowPattern) | ||||
security |
ExternalVirtualLink Instance
AAI (l3-network) | ECOMP IM | ETSI IFA013 (VirtualLink) | Comments |
network-id | nsVirtualLinkInstanceId | ||
network-name | description | ||
network-role | |||
network-technology | |||
neutron-network-id | ResourceHandle (vimId,resourceProviderId,resourceId) | ||
is-bound-to-vpn | |||
service-id | nsInstanceId | ||
network-role-instance | |||
resource-version | |||
orchestration-status | |||
heat-stack-id | |||
mso-catalog-key | |||
contrail-network-fqdn | |||
model-invariant-id | |||
model-version-id | virtualLinkDescId | ||
persona-model-version | |||
model-customization-id | |||
widget-model-id | |||
widget-model-version | |||
physical-network-name | |||
is-provider-network | |||
is-shared-network | |||
is-external-network | |||
selflink | |||
operational-status | |||
nslinkport |
VNF Node
SDC (VNF) | AAI | ECOMP IM | ETSI IFA014 (virtualLinkDesc) | Comments |
invariantUUID | ||||
UUID | vnfdId | |||
customizationUUID | ||||
version | vnfdVersion | |||
name | ||||
description | ||||
type | ||||
category | ||||
subcategory | ||||
resourceVendor | vnfProvider | |||
resourceVendorRelease | ||||
resourceVendorModelNumber | ||||
nf_role | NF-Role | |||
nf_naming_code | NFC-Naming_Code | |||
nf_type | NF-TYPE | |||
nf_code | NF-CODE | |||
nf_naming | ||||
availability_zone_max_count | ||||
min_instances | ||||
max_instances | ||||
NF-FUNCTION | ||||
vnfProductName | ||||
vnfSoftwareVersion | ||||
vnfProductInfoName | ||||
vnfProductInfoDescription | ||||
vnfmInfo | ||||
localizationLanguage | ||||
defaultLocalizationLanguage | ||||
vnfExtCpd |
VNF Instance
AAI (generic-vnf) | ECOMP IM | ETSI IFA007 (VNF) | Comments |
vnf-id | vnfInstanceId | ||
vnf-name | vnfInstanceName | ||
vnf-name2 | vnfInstanceDescription | ||
vnf-type | VF Type | ||
service-id | nsInstanceId | ||
regional-resource-zone | |||
prov-status | |||
operational-status | |||
license-key | |||
equipment-role | |||
orchestration-status | instantiationState instantiatedVnfInfo.vnfState instantiatedVnfInfo.scaleStatus | ||
heat-stack-id | |||
mso-catalog-key | |||
management-option | |||
ipv4-oam-address | |||
ipv4-loopback0-address | |||
nm-lan-v6-address | |||
management-v6-address | |||
vcpu | |||
vcpu-units | |||
vmemory | |||
vmemory-units | |||
vdisk | |||
vdisk-units | |||
in-maint | |||
is-closed-loop-disabled | |||
resource-version | |||
summary-status | |||
encrypted-access-flag | |||
entitlement-assignment-group-uuid | |||
entitlement-resource-uuid | |||
license-assignment-group-uuid | |||
license-key-uuid | |||
model-invariant-id | VNF Model ID | vnfdId | |
model-version-id | VNF Model Version | vnfdVersion | |
persona-model-version | |||
model-customization-id | |||
widget-model-id | |||
widget-model-version | |||
as-number | |||
regional-resource-subzone | |||
nf-type | |||
nf-function | |||
nf-role | |||
nf-naming-code | |||
selflink | |||
ipv4-oam-gateway-address | |||
ipv4-oam-gateway-address-prefix-length | |||
vlan-id-outer | |||
nm-profile-name | |||
VLAN Range Plan | |||
Homing Policy | |||
Network Role | |||
Target Node Prompt | |||
VNF Name Prompt | |||
VNF Naming Policy | |||
VNF Network Tag | |||
vnfProvider | |||
vnfProductName | |||
vnfSoftwareVersion | |||
onboardedVnfPkgInfoId | |||
extManagedVirtualLinkInfo | |||
onboardedVnfPkgInfoId | |||
vnfConfigurableProperty | |||
metadata | |||
extension |