DRAFT PROPOSAL FOR COMMENTS

The content of this template is expected to be fill out for M1 Release Planning Milestone.

Overview

Scope

What is this release trying to address?

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. 

• 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 functionality is drastically reduced and the time to delivery is dramatically decreased.

Focus: Service Instantiation; License Management; Network Address Space Management

Use Cases

1. In Amsterdam, we will target packaging of the vCPE and VoLTE VNFs

   1. Will address any BSS/OSS interactions described in these use cases

Minimum Viable Product

The MVP allows for the definition of BSS/OSS - ONAP APIs that:

1. Support simple Service Instantiation Requests;

2. Provide Licence usage information to the BSS/OSS;

3. Allow Network Address Spaces to be provided to the ONAP instance.

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.

Epics

Stories

Longer term roadmap

The External API Framework project describes and defines the APIs between ONAP and External Systems, including ONAP interfaces targeted on BSS/OSS, peering, B2B, etc. Proposed initial focus may be on the Common APIs between ONAP and BSS/OSS. 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.

Scope:

• Deliver points of interoperability between ONAP and External Systems

• Initial focus on ONAP APIs to BSS/OSS

• May support the following capabilities:
  
  

  • Service feasibility; 

  • Service provisioning configuration & activation; 

  • Usage events & metrics; 

  • License accounting; 

  • Service performance & quality; 

  • Service Trouble management;

  • Service policy; 

  • Capacity engineering;

  • Address allocation management

• initial focus is likely to be: “Service provisioning configuration & activation”, "License management", and “Address allocation management”

• Definition of Use Cases, Interactions, and Information Model engaging service providers and BSS/OSS vendors

• API development (in conjunction with specific ONAP component projects)

  • Well defined specifications for the NB APIs (e.g., JSON Swagger). 

  • ONAP implementation of these APIs

• Work with Modeling project 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

• Main deliverables of this project may include: 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.

Release Deliverables

Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.

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.

ONAP Dependencies

• Modeling Project & Sub-Committee

  • 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

• Service Orchestrator Project

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

• SDC (service model)

• DMaaP

  • Data Filtering, data transport, and data processing

• Micro-Service Bus (API Transport and Authentication / Authorization)

• Standards Coordinator

  • Related activities in the TM Forum, MEF, etc.

• This project will also analyze the functionality of the implemented set of APIs in ONAP components that are relevant to providing the described external interface functionality. Mapping and alignment between this project and the ONAP components implementing the supporting APIs is essential since functional API gaps and potential enhancements will be identified based on the functional analysis. This project also allows the pertinent ONAP component specific external API artifacts (e.g., JSON/Swagger) to be collected and referenced. 

Architecture

High level architecture diagram

Open

API Incoming Dependencies

List the API this release is expecting from other releases.
Prior to Release Planning review, Team Leads must agreed on the date by which the API will be fully defined. The API Delivery date must not be later than the release API Freeze date.

Prior to the delivery date, it is a good practice to organize an API review with the API consumers.

API Outgoing Dependencies

API this release is delivering to other releases.

Third Party Products Dependencies

Only modeling tools, e.g., Eclipse Papyrus.

Testing and Integration Plans

Only models and API definition. No implementation as part of this project.

Gaps

This section is used to document a limitation on a functionality or platform support. We are currently aware of this limitation and it will be delivered in a future Release.
List identified release gaps (if any), and its impact.

Known Defects and Issues

Provide a link toward the list of all known project bugs.

Risks

List the risks identified for this release along with the plan to prevent the risk to occur (mitigation) and the plan of action in the case the risk would materialized (contingency).

Resources

Fill out the Resources Committed to the Release centralized page.

Release Milestone

The milestones are defined at the Release Level and all the supporting project agreed to comply with these dates.

Team Internal Milestone

Documentation, Training

• Highlight the team contributions to the specific document related to he project (Config guide, installation guide...).

• Highlight the team contributions to the overall Release Documentation and training asset

• High level list of documentation, training and tutorials necessary to understand the release capabilities, configuration and operation.

• Documentation includes items such as:

  • Installation instructions

  • Configuration instructions

  • Developer guide

  • End User guide

  • Admin guide

  • ...

Other Information

Vendor Neutral

If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.

Free and Open Source Software

FOSS activities are critical to the delivery of the whole ONAP initiative. The information may not be fully available at Release Planning, however to avoid late refactoring, it is critical to accomplish this task as early as possible.
List all third party Free and Open Source Software used within the release and provide License type (BSD, MIT, Apache, GNU GPL,... ).
In the case non Apache License are found inform immediately the TSC and the Release Manager and document your reasoning on why you believe we can use a non Apache version 2 license.

Each project must edit its project table available at Project FOSS.

Charter Compliance

The project team comply with the ONAP Charter.