[ExtAPI] Casablanca M1 Release Planning Template
ONAP External APIs expose the capabilities of ONAP. They allow ONAP to be viewed as a “black box” by providing an abstracted view of the ONAP capabilities.
They support that an external consumer of ONAP capabilities can be authenticated and authorized. They can also be used for connecting to systems where ONAP uses the capabilities of other systems.
Note 1: External API does not include all the B2B capabilities of exposure (e.g. partner management)
Note 2: The case where trusted providers of a service (e.g. operator owned transport, or cloud infrastructure) do not need to pass through External API.
For example, External APIs between ONAP and BSS/OSS allow Service Providers to utilize the capabilities of ONAP while using their existing BSS/OSS environment minimizing customization
It is envisioned that from a Service Provider to Partner Provider interaction context (i.e. MEF Interlude), the ONAP External API will support the following types of interacts:
•Service Provider controls aspects of the Service within the Partner domain (on behalf of the Customer) by requesting changes to dynamic parameters as permitted by service policies.
•Service Provider queries state of the Service.
•Service Provider requests change to administrative state or permitted attributes of a Service.
•Service Provider request creation of connectivity between two Service Interfaces as permitted by established business arrangement.
•Service Provider request instantiation of functional service components as permitted by established business arrangement.
•Service Provider queries the Partner for detailed information related to Services provided by the Partner to the Service Provider.
•Service Provider receives Service specific event notifications (e.g., Service Problem Alerts) from the Partner.
•Service Provider receives Service specific performance information from the Partner.
•Service Provider request Service related test initiation and receive test results from the Partner.
The content of this template is expected to be fill out for M1 Release Planning Milestone.
- 1 Overview
- 2 Scope
- 3 Sub-Components
- 4 ONAP Dependencies
- 5 Architecture
- 6 Testing and Integration Plans
- 7 Gaps
- 8 Known Defects and Issues
- 9 Risks
- 10 Resources
- 11 Release Milestone
- 12 Team Internal Milestone
- 13 Documentation, Training
- 13.1 Note
- 14 Other Information
Overview
Project Name | ExtAPI |
---|---|
Target Release Name | Beijing, Casablanca, Dublin |
Project Lifecycle State | Incubation; Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
Participating Company | AT&T, CenturyLink, China Mobile, China Telecom, Orange, PCCW Global, Turk Telekom, Verizon, Amdocs, Ciena, Huawei, Intel, Netcracker, ZTE, MEF |
Scope
What is this release trying to address?
Deliver points of interoperability between ONAP and External Systems
Focus on ONAP External APIs to BSS/OSS (i.e., MEF Legato)
Service Catalog
Add notification for serviceCatalog API (stretch goal)
Description:
Allow BSS catalog function to receive service catalog notification as serviceSpec status change or characteristic change (new value in an enum list for example). Could be interesting to track these serviceSpec update to update accordingly productSpec
Relevance:
Complexity: Easy
Prerequisites: It requires to have a notification from SDC because NBI will not pool AAI
Resources:
Improve ServiceCatalog API for service characteristics
Description:
Expose from NBI json (or other format) file describing the serviceSpec characteristic (same type of file we can retrieve on MEF Git Hub to describe an UNISpec for example)
Convert YAML in CSAR to ONAP wide consistent JSON schema for Service Characteristic Input parameters and provide across the ServiceCatalog API
Relevance:
Complexity: Medium
Prerequisites:
Resources:
Service Ordering
Upgrade Service Request Status for serviceOrder API (Systems engineering for documenting Use Case; get service_order, status of order item; identify details of status information) (stretch goal)
Description:
Provide summary and detailed status for both Infrastructure requested VNFs and Customer requested VNFs.
Requestors that create transaction requests on the ONAP Platform, have a need to effectively manage the requests they create. The Requestor is the responsible owner for the transaction and thus, need the ability to have visibility into the status of their requests
BSS/OSS system will call the API providing one of the following options:
1.Specific Service Request ID
2.Many Service Requests based on Selection Criteria such as: Service Request Status and/or Time Frame where appropriate, (e.g., past day completions)ONAP will respond with the current status of the workflow for the selected request(s). The status can include not only a status summary of the requests but also the steps taken, start/stop time of the steps taken, notifications generated, and the remaining steps that need to be taken. Different workflows will have different numbers of steps, so this API will need to provide a name or identifier for any and all steps
Check Request status via GET {{url}}/ecomp/mso/infra/orchestrationRequests/v4/{requestId}
Check requestStatus: it must be equal to (if percentProgress not equal to 100, we’ll pooling SO till percentProgress = 100):
Relevance:
Complexity: Easy
Prerequisites: Could implement in two phases, 1st phase implement status details that are currently available in the Service Orchestration (SO) API, while the 2nd phase would enhance SO and/or the SO API with any additional status information
Resources:
Add notification for serviceOrder API
Description:
Allow BSS (or any other) system to receive order/OrderItem update. BSS (or any other system) will not have to pool. We can allow several distinct notification (Nice to have: let subscriber specify notification contains). Minimum is to provide ServiceOrderStateChangeNotifications etc to HUB subscriber. After if we’re able to get a notification from SO it will be perfect but initial requirement is only at external API northbound
Notifications related to ServiceOrder: - ServiceOrderCreationNotification - ServiceOrderAttributeValueChangeNotification - ServiceOrderStateChangeNotification - ServiceOrderInformationRequiredNotification - ServiceOrderRemoveNotification
Relevance:
Complexity: Easy
Prerequisites: Nothing for basic deliver…SO notifications to have high performance (without SO notification, NBI will pool SO as of today)
Resources:
Update ServiceOrder to to accommodate Service Chaining. (systems engineering) (implementation stretch goal)
Description:
Enhance the Service Order API (TMF 641) to allow BSS/OSS the ability to flag services as part of a “group”. Enhance the Service Inventory API (TMF 638) to allow BSS/OSS to retrieve Service Inventory by “group”.
Relevance:
Complexity: Easy
Prerequisites: Service Orchestrator (SO) and its external API, A&AI and its API to SO and its external API
Resources:
Update ServiceOrder to manage Service modification request UC (basic, delete and create for Casablanca, will need SO to evolve for full modify)
Description:
This will allow BSS system to trigger service modification request. By modification we mean: characteristic value change, status change (other ?). Minimum could be to handle modification that can be managed in SO with a Delete Service and then Add service (this is a change up to nbi but remove/add down to nbi). This is not service order modification butt service modification on existing service instance in the inventory (new service order with action change)
Possibly related to CC VPN use case, explore other use cases
Relevance:
Complexity: Average to High depending on SO capability to handle service modification
Prerequisites: could require SO upgrade – Check if some use case can be handle by NBI only (triggering add/remove in SO)
Resources:
Update ServiceOrder to provide user and system workload information for both Infrastructure requested VNFs and Customer requested VNFs (systems engineering, implementation stretch goal)
Description:
Requestors that create transaction requests on the ONAP Platform, have a need to effectively manage the requests they create. The Requestor is the responsible owner for the transaction and thus, need visibility into the volumes of requests created by a requestor, in order to better balance the workload among their labor resources.
•BSS/OSS system will call the API providing one of the following options:
1.Specific Service Request ID
2.Specific User ID of the Requestor
3.All UsersONAP will respond with what activity is happening, who is doing it, and how old is it. Profile information can include Service Request Type, Creation/Completion Dates, and User ID of the Requestor. This information may require a dip into VID
Relevance:
Complexity: Average
Prerequisites: Could implement in two phases, 1st phase implement request profile information that is currently available in the Service Orchestration (SO) API, while the 2nd phase add additional status information from VID
Resources:
Service Inventory
Add notification for service Inventory API (stretch goal)
Description: Allow BSS (or any other) system to receive service state update.
Relevance:
Complexity: Medium
Prerequisites: It requires to have a notification from AAI because NBI will not pool AAI; may be able to use DMaaP capability to support
Resources:
Update Service Inventory to accommodate Service Chaining. (systems engineering; implementation as a stretch goal)
Description:
Enhance the Service Order API (TMF 641) to allow BSS/OSS the ability to flag services as part of a “group”. Enhance the Service Inventory API (TMF 638) to allow BSS/OSS to retrieve Service Inventory by “group”.
Relevance:
Complexity: Easy
Prerequisites: Service Orchestrator (SO) and its external API, A&AI and its API to SO and its external API
Resources:
Improve ServiceInventory API
Description:
As of now we retrieve very few information from AAI – Perhaps digging more in the instantiated VNF or VF could allow us to have more information as service state or serviceCharacteristic for example.
Relevance:
Complexity
Prerequisites: Need AAI expertise; Need enhancement to AAI UI to see more topology details across API
Resources:
Performance Management (specification focus) (stretch goal: implementation)
Provide performance data for both Infrastructure VNFs and Customer VNFs
Description:
Capacity planning engineers must be able to determine the performance and quantities of VNFs running on the network for planning purposes. Performance Management data is required to develop Site Level Tenant and VNF & VM Forecasts that are the basis for Capacity Planning of the Network Infrastructure. May also be used in support of customer self service to provide customers with performance information about their specific services and VNFs
BSS/OSS system will call the API providing starting and ending dates and times. This API will be called either on-demand or on a regular timed basis. ONAP will respond with performance management data from DMaaP and Performance Data Store, may be trended for forecasting process, and include specific metrics & KPIs for all existing VNFs/VMs in service. May make use of TM Forum Performance Management API (TMF 628).
Relevance:
Complexity: Easy
Prerequisites: Could implement in two phases, 1st phase implement performance information that is currently available in the DMaaP API, while the 2nd phase enhance the DMaaP API with additional performance information. Requires additional micro-service development for collecting information from DMaaP or data store to store and aggregate the information
Resources:
License Usage (stretch goal) (specification focus)
Integration
Integrate External API/NBI within ONAP MSB
Description: May need to consider how External API agent functionality can be decoupled from MSB
Relevance:
Complexity
Prerequisites:
Resources:
Build End-to-End Use Case
Description: Showcase External API from a complete Service Lifecycle perspective. Apply ONAP Use Cases.
Relevance:
Complexity
Prerequisites:
Resources:
Initial focus specification of ONAP External APIs supporting Inter-Provider (i.e., MEF Interlude)
Service Control (specification focus)
Service State (operational state) (specification focus)
Service Inventory / Details (specification focus)
Explore Role-based view of single APIs descriptors for both Legato and Interlude
Alignment with MEF Legato, MEF Interlude and TM Forum APIs
Definition of Use Cases, Interactions, and Information Model engaging service providers and BSS/OSS vendors
UML Models (Eclipse Papyrus) (with Modeling sub-committee) and API definition (JSON Swagger) for
License Usage
Service Modeling and Service Topology
Service Inventory
Service State Management
Service Quality Management
Define API Styles to be applied to External APIs (along with Micro-service Bus (MSB) and Modeling Project)
API development (in conjunction with specific ONAP component projects)
Well defined specifications for the NB APIs (e.g., JSON Swagger / OpenAPI).
ONAP implementation of these APIs
Architecture for External APIs
Identification and involvement of stakeholder ONAP projects
Describe key External API foundation functionalites
Work with Architecture and MSB projects
Document the role and requirements of External APIs in Model Driven ONAP
Work with Modeling project and sub-committee to explore a 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 functionality is drastically reduced and the time to delivery is dramatically decreased.
Explore use of Model Driven Tool Chain to automatically generate APIs based on models with Modeling Project
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).
The TSC identified the following Use cases for Release A:
TSC Use Case | VNFs identified in TSC Use case |
---|---|
N/A | |
vBNG, vG_MUX, vG, vAAA, vDHCP, vDNS | |
vFW, vPacketGenerator, vDataSink, vDNS, vLoadBalancer, all VPP based. | |
vSBC, vPCSCF, vSPGW, vPCRF, VI/SCSCF, vTAS, VHSS, vMME |
The External API developed by this project are applicable to the Services identified in the TSC E2E use cases.
Minimum Viable Product
Documentation of User Stories; Use Cases and Interactions (e.g., UML); Information Models (e.g., UML); Data Models (e.g., JSON); Interface Profiles and Functional Definition;
ONAP Component Mapping and Functional Analysis;
Code contribution for External API Agent functionality.
Functionalities
List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In the JIRA Priority field, specify the priority (either High, Medium, Low). The priority will be used in case de-scoping is required. Don't assign High priority to all functionalities.
Initial focus on ONAP External APIs to BSS/OSS (i.e., MEF Legato)
Service Catalog
Service Ordering (including Service Instantiation)
Service Inventory
Service Topology (stretch goal) (specification focus)
License Usage (stretch goal) (specification focus)
Initial focus specification of ONAP External APIs supporting Inter-Provider (i.e., MEF Interlude)
Service Control
Service State (operational state)
Service Inventory / Details
Epics
Stories
Longer term roadmap
Provide 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.
Provide a way to rapidly integrate new Services and Service Components into ONAP so that they can quickly introduce capabilities for their customers and within their infrastructure.
Enable management 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 functionality is drastically reduced and the time to delivery is dramatically decreased.
It is envisioned that from a Service Provider to BSS/OSS interaction context (i.e. MEF Legato), the ONAP External API will support the following types of interacts:
BSS/OSS retrieves Service Models
BSS/OSS requests service feasibility determination.
BSS/OSS requests reservations of capabilities related to a potential Service.
BSS/OSS requests activation of Service.
BSS/OSS receives Service activation tracking status updates.
BSS/OSS retrieves Service Inventory
BSS/OSS receives usage events due to a Customer initiating dynamic activity on their Service (e.g., increase in bandwidth).
BSS/OSS receives a summary of Service quality and usage information.
BSS/OSS receives Service state and fault event information
BSS/OSS receives Service Activation Testing results.
BSS/OSS receive capability information about the Service layer.
BSS/OSS manages Licenses
BSS/OSS receives License Usage information
It is envisioned that from a Service Provider to Partner Provider interaction context (i.e. MEF Interlude), the ONAP External API will support the following types of interacts:
Service Provider controls aspects of the Service within the Partner domain (on behalf of the Customer) by requesting changes to dynamic parameters as permitted by service policies.
Service Provider queries state of the Service.
Service Provider requests change to administrative state or permitted attributes of a Service.
Service Provider request creation of connectivity between two Service Interfaces as permitted by established business arrangement.
Service Provider request instantiation of functional service components as permitted by established business arrangement.
Service Provider queries the Partner for detailed information related to Services provided by the Partner to the Service Provider.
Service Provider receives Service specific event notifications (e.g., Service Problem Alerts) from the Partner.
Service Provider receives Service specific performance information from the Partner.
Service Provider request Service related test initiation and receive test results from the Partner.
Release Deliverables
Deliverable Name | Deliverable Description |
---|