[ExtAPI] Dublin M1 Release Planning

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.


Overview

Project Name

ExtAPI

Project Name

ExtAPI

Target Release Name

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

      • Service Ordering

      • Service Inventory

        • Add TMForum Hub/Event for service inventory.

        • Read AAI-EVENT with DMAAP integration

      • 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:

      • Service Topology (stretch goal) (specification focus)

      • 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

TSC Use Case

VNFs identified in TSC Use case

(obselete)Use Case: VoLTE (vIMS + vEPC)

N/A

Use Case: Residential Broadband vCPE (Approved)

vBNG, vG_MUX, vG,  vAAA, vDHCP, vDNS

Use Case: vFW/vDNS (Approved)

vFW, vPacketGenerator, vDataSink, vDNS, vLoadBalancer,

all VPP based.

Use Case: VoLTE(approved)

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

key summary type created updated due assignee reporter priority status resolution
Loading...
Refresh

Stories

key summary type created updated due assignee reporter priority status resolution
Loading...
Refresh



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

Deliverable Name

Deliverable Description

Documentation

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

External API

JSON Swagger / OpenAPI for the External Interface

External API Agent Software

Code contribution for External API Agent functionality

Sub-Components

List all sub-components part of this release.
Activities related to sub-component must be in sync with the overall release.

Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.

  1. External API Agent:

    1. Core Agent Functionality

    2. Service Catalog API

    3. Service Ordering API

    4. Service Inventory API

ONAP Dependencies

List the other ONAP projects your depends on.

Dependent on APIs from SDC, SO, and AAI

Architecture

High level architecture diagram

At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.

Block and sequence diagrams showing relation within the project as well as relation with external components are expected.

Anyone reading this section should have a good understanding of all the interacting modules.

Platform Maturity

Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.

Area

Actual Level

Targeted Level for current Release

How, Evidences

Comments

Area

Actual Level