Defining ONAP APIs With BSS/OSS
28 June 2017
Andy Mayer,
Ph.D.
© 2016 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.
AT&T Proprietary (Internal Use Only). Not for use or disclosure outside the AT&T companies except under written agreement.
What
Common APIs between ONAP and BSS/OSS allow
Service Providers to utilize the capabilities of
ONAP while using their existing BSS/OSS
environment minimizing customization
E – Services
ONAP Architecture
ONAP Portal
Dashboard
OA&M
Operation
Administrati
on
&
Maintenance
Recipe/Engineer
ing Rules &
Policy
Distribution
Service Design & Creation
Policy Creation
Analytic Application
Design
Design Functions
BSS / OSS
Data
Big
External Data Movement & APIs
Active &
Available
Inventory
Service
Orchestrator
Common Services, Data Movement, Access Control & APIs
Data Collection &
Analytics
Operational Functions
ONAP
Controlle
r
Storage
Compute
Networking
VNFs / Applications
Controllers
Engineering Rules
& Inventory
Why
•
•
•
•
Service Providers need a clear and unambiguous ONAP
service abstraction so that the BSS/OSS can exchange
service requirements and service capabilities in a
common and consistent fashion.
Service Providers want to rapidly integrate new
Services and Service Components into ONAP so that they
can quickly introduce capabilities for their customers
and within their infrastructure.
Service Providers want to manage the entire lifecycle
of Services within ONAP in a common way so that they
can ensure orchestration, manageability and control of
each Service in an easily integrateable and low cost
way.
Model Driven approach: a cohesive way to have a shared
view of information across ONAP external interfaces
that can be used for or be input into a model driven
process whereby the cost of delivering platform
BSS/OSS Interactions With
E – Services
BSS / OSS
ONAP
Big Data
Service feasibility;
External Data Movement & APIs
ONAP Portal
Dashboard
Service provisioning
configuration &
activation;
OA&M
Active &
Request
fallout;
Operation
Service
Available
Administratio
Usage events & metrics;
Orchestrator
n
Inventory
License
& accounting;
Maintenance
Service performance & quality (e.g., KPI);
Common
Services, Data Movement, Access Control & APIs
Service trouble
management;
Recipe/Engineeri
Service policy;
ng Rules &
Policy
Capacity engineering; Data Collection
Controllers
Distribution
Engineering Rules
Address allocation management;
& Analytics
& Inventory
Operational
Functions
Service Design & Creation
Policy Creation
Analytic Application Design
Design
Functions
ONAP
Controll
er
© 2017 AT&T Intellectual Property. All rights reserved. AT&T, Globe logo, Mobilizing Your World and DIRECTV are registered trademarks and service marks of AT&T Intellectual Property and/or AT&T affiliated companies. All other marks are the property of their respective owners.
Storage
Compute
Networking
VNFs / Applications
BSS/OSS Interactions With
ONAP Portal
E – Services
BSS / OSS
ONAP
Big Data
Initial Focus on BSS/OSS:
External
Dashboard
Service
provisioning configuration
Data Movement & APIs
& activation; Active &
OA&M
Operation
License management;
Available
Administratio
Address nallocation management;
& Maintenance
Recipe/Engineeri
ng Rules &
Policy
Distribution
Common Services, Data Movement, Access Control & APIs
Data Collection
& Analytics
Operational
Functions
Service Design & Creation
Policy Creation
Analytic Application Design
Design
Functions
Inventory
Service
Orchestrator
ONAP
Controll
er
© 2017 AT&T Intellectual Property. All rights reserved. AT&T, Globe logo, Mobilizing Your World and DIRECTV are registered trademarks and service marks of AT&T Intellectual Property and/or AT&T affiliated companies. All other marks are the property of their respective owners.
Storage
Compute
Networking
VNFs / Applications
Controllers
Engineering Rules
& Inventory
Related ONAP Projects
•
Modeling Project

•
Service Orchestrator Project

•
Define external API capabilities to support the Change Management
DMaaP

•
Gather information about the relevant Service Orchestrator APIs
(particularly the Service Instantiation API). Will collaborate
with Service Orchestrator team to ensure that APIs remain
consistent for R1.
Change Management project

•
Identify overall modeling guidelines and approaches, determine
modeling tools and tool chaining, and identification of industry
standard models (e.g., TMF SID, ONF TAPI, etc.) that may be
applied to the APIs
Data Filtering, data transport, and data processing
Standards Coordinator

Related activities in the TM Forum, MEF, etc.
High Level Project Plan For Release 1
Focus: Service Instantiation; License Management; Network Address
Space Management
Common APIs between ONAP and BSS/OSS allow Service Providers to
utilize the capabilities of ONAP using their existing BSS/OSS
environment with minimal customization
1. Analysis of current Service Orchestrator APIs and flows
2. Functional description of target ONAP capabilities for
interactions with BSS/OSS
3. Functional reference architecture (MEF LSO mapping, Interface
Reference Point definition, etc.) Note that the BSS/OSS to ONAP
APIs are relevant to the MEF LSO Legato Interface Reference
Point.
4. Identify BSS/OSS – ONAP Use Cases and interactions
5. Definition of information model for ONAP service abstraction
(with Modeling Project)
6. API definition (e.g., JSON) in cooperation with ONAP Projects
(including Service Orchestrator)
Time Line
ONAP-BSS/OSS APIs
M1 Plan
M2
Select a period to highlight at right. A legend describing the
follows.
1 charting
Duration
ACTIVITY
PLAN START
ProjectProject
June Scope
WEEKS
29 June
PLAN12
DURATION
1
Analyze SO APIs
1
4
Fnct Ref Arch
1
4
Target Capabilities
1
4
Use Cases
2
4
Service Abstraction
2
6
UML Models - SI
4
4
API - SI
6
5
UML Models - Lic
4
4
API - Lic
6
5
UML Models - Addr
4
4
API - Addr
6
5
2
3
4
5
M3 Start
Actual
Functional
API
ity
24 August
3 August
6
7
8
9
10 11 12 13
Possible Approach
Define BSS/OSS – ONAP Use Cases, Interactions, Information
Model, and API description
• Apply MEF’s LSO Reference Architecture; Interface
Reference Points, Operational Threads, etc. (MEF was
working with OPEN-O on relating architecture and APIs)
• Work with Modeling Project to determine base service
abstraction Information Model on best in breed standard
models (e.g., ONF TAPI, TM Forum, etc.)
• API Development:
 Well defined specifications for the BSS/OSS APIs (e.g., JSON
Swagger). These define what the BSS/OSSs would need to build to.
 An ONAP implementation of these APIs
o Engage MEF / ONF TAPI based APIs where applicable
o Explore use of Tool Chain to automatically generate APIs based on
models
Characterize Current ONAP Interactions with
BSS/OSS
•
Identify relevant ONAP Component APIs
•
Characterize and describe interactions supported
by each API
•
This set of interactions becomes the current
capabilities base that will be used for gap
analysis and identification of API enhancements
or the need for additional APIs
ONAP Component
BSS/OSS
Type
Interaction Description
Service
Orchestrator
Ordering
Service Instantiation
. . .
. . .
. . .
10
Describe Target Use Cases & Interactions (Example)
sd Simple
Serviceability and Ordering
Customer
BSS/OSS
ONAP
Network Cloud
Feasibility & Quote Inq()
Component Serviceability()
Response()
Response()
Customer Order()
Service Fulfillment()
NF & Connect Activation()
Response()
Test Rqst()
Response()
Response()
Response()
11
Describe Shared ONAP Service Abstraction (Example)
class Serv ice Characteristics
ServiceNetworkAssociation
Serv iceNetw orkAssociation
DirectedGraph
Recipe
CatalogItem
CatalogItem
Serv iceRecipe
«use»
«flow»
A
0..*
Serv iceCatalogItemVersion
ServiceCatalogItemModificationsRecordedAs
*
Serv iceCatalogItemCharacteristicValueRelationship
ServiceCatalogItemCharacteristicValueReferences
0..*
0..*
Serv iceCatalogItemCharacteristicValue
-
unitOfMeasure: String
value: String
valueType: String
0..1
*
0..*
ServiceCatlogItemCharUseDescribedBy
0..*
1
1 -
AT&TContact: char
Capacity: Document
1..
Category: DropDown
Constraints
Cost: char
D2RequirementsChecklist: Document
EntitlementID: char
EntitlementUnitNumber: char
EntitlementUnitType: char
FaultRequirements: Document
Features: Document
History: char
Icon: Image
LicensingModel: DropDown
Performance: Document
Requirements
ServiceDescription: char
ServiceDisplayName: char
ServiceSystemName: Char
ServiceUUID: char
Status: char
Subcategory: DropDown
Tags/Keywords: Char
Template: DropDown
TestScripts: Document
VendorTestResults: Document
Version: char
VF-SpecificPolicies: File
VFArtifacts: char
VFConfigParameters: File
VFImage: char
12
0..*
InstanceItem Requires
0..*
InstanceItem
Serv iceInstance
0..*
1
ServiceInstanceCharactieristicValue
DefinesTheConfigurationOf
*
Serv iceInstanceCharacteristicValue
ServiceSpecDescribes
*
0..1
Serv iceItemCharacteristic
0..1
Description: String
Name: String
0..*
0..1
Serv iceCatalogItemCharacteristicRelationship
0..*
ServiceCatalogItemCharacteristicReferences
ServiceCatalogItemCharacteristicValueInstanciatedAs
0..*
ServiceInstanceCharacteristicValueReferences
ServiceCatalogItemDescribedBy
0..*
Can have high level
characteristic to address
functional dimensions,
including application,
operations, security, &
environment. Can be
further broken down to
address multi-tenancy.
ServiceCatalogItemMadeAvailableAs
ServiceNetworkAssoc
may be the relationship
and not an object by
itself
0..*
CanBeOverridden: boolean
MaxCardinality: int
MinCardinality: int
ServiceCatalogItemEnumeratedBy
1
Serv iceCatalogItem
Serv iceCatalogItemCharacteristicUse
-
0..*
Name:
Author:
Version:
Created:
Updated:
Service Characteristics
KS0567
1.0
10/26/2015 12:00:00 AM
10/21/2016 1:22:52 PM
*
Define APIs (Example)
createServiceInstance
Client
Service Instantiation
Client
Service Instantiation
POST /serviceInstances/v3
POST /serviceInstances/v3/
{serviceInstanceId}/replace
202 with serviceInstanceId and requestId
or
4xx/5xx with requestError
202 with new serviceInstanceId and requestId
or
4xx/5xx with requestError
(0 … Many) asyncRequestStatus callbacks
Client
replaceServiceInstance
sync response
(0 … Many) asyncRequestStatus callbacks
optional async responses
Service Instantiation
Client
deleteServiceInstance
Client
13
sync response
optional async responses
Service Instantiation
updateServiceInstance
Service Instantiation
Client
Service Instantiation
DELETE /serviceInstances/v3/{serviceInstanceId}
PUT /serviceInstances/v3/{serviceInstanceId}
202 with serviceInstanceId and requestId
or
4xx/5xx with requestError
sync response
202 with serviceInstanceId and requestId
or
4xx/5xx with requestError
sync response
(0 … Many) asyncRequestStatus callbacks
optional async responses
(0 … Many) asyncRequestStatus callbacks
optional async responses
Client
Service Instantiation
Client
Service Instantiation
BACKUP MATERIAL
14
© 2016 AT&T Intellectual Property. All rights reserved. AT&T and the AT&T logo are trademarks of AT&T Intellectual Property.
AT&T Proprietary (Internal Use Only). Not for use or disclosure outside the AT&T companies except under written agreement.