Overview

Scope

What is this release trying to address?

• Deliver increased interoperability between ONAP and External Systems ( e.g. Service Catalog Notifications )
• Continue to enhance ONAP External APIs exposed to BSS/OSS (e.g. Increase support for SO Service APIs , macro mode) 
  • Service Catalog
    • Add notification for serviceCatalog API
      
      • 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: Moderate - need to subscribe to authenticated topic
      • Prerequisites: It requires to have a notification from SDC via DMaaP
      • Resources: Adrian O'Sullivan
    • (Specification Focus) Analysis of new Operation Domain Manager APIs in SDC and impact on support POST for ServiceSpecification Resource. Currently Telstra are working on SDC APIs for onboarding a Partner ServiceSpecification reference in SDC with all the information to communicate with Partners External APIs for Service Instantiation. ( Stretch goal - resources permitted to look at supporting POST ServiceSpecifcation - potential to use jolt to transform to new SDC API format.
  • Service Ordering
    
    • Add Support for serviceOrder API for Service Instantiation via macro mode
      
      • Description: 

        • With Dublin, a new mode is available in SO to instantiate a service : the "macro" mode.

          In SDC, a service can be declared with an instantiationType equal to "A-la-carte" or equal to "Macro". This information is then available in the Tosca service definition file.

          When "Macro" mode is chosen for a service, the SO will use different kind of BPMN workflow.

          This "macro" mode need to be managed by NBI.

          NBI needs to look at service definition in Tosca file, select the mode, build the "macro" request toward SO  when service instantiationType is "Macro". 

          REQUEST 1 : NBI have to send a request to SO with the parameter "aLaCarte": false when instantiationType is Macro in service definition file

          In macro mode, the SO request may also contain, in the "userParams" section, all needed information about VNFs and VF-module(s) to be instantiated.

          All those necessary information are in the Tosca service definition file generated by SDC.

          If NBI do not fill those information, the serviceOrder sent to NBI will have to provide those informations (that means an external system will have to do the job)

          REQUEST 2 : NBI to look at VNF, VF-module and Network in the Tosca service definition file in order to build the full "macro" request toward SO.

      • Relevance:
      • Complexity: High
      • Prerequisites: 
      • Resources: Romain and Rene
    • Update serviceOrder API to use GR_API
      
      • Description: 

        • SO can use two kind of API with SDNC : Generic-Resource API (GR_API) or VNF_API.It seems that it is better to indicate to SO to use GR_API now. It is the value of the field "testApi" that need to be modified in SO request to instantiate service object. Can be an environment variable.

      • Relevance:
      • Complexity: Easy
      • Prerequisites: 
      • Resources: Romain
    • Handle action modify in ServiceOrder in a manner other than recreate Service 
      
      • Description: 

        • 5G Network Slicing plan to have new SO capability for Service Modifications, specifically allowing an instantiated and activated service to be deactivated without being deleted.

      • Relevance:
      • Complexity: Moderate
      • Prerequisites: 
      • Resources: Adrian O'Sullivan
    • Update ServiceOrder to accommodate Service Characteristics of "object" type
      
      • Description: 

        • Need to handle service orders which use "object" type in the serviceCharacteristics, i.e. utiizing the new specificationInputSchema . Also update the object to be stored as "object" v "Object" in the service catalog response.

      • Relevance:
      • Complexity: Easy
      • Prerequisites: 
      • Resources: Adrian O'Sullivan - Note work complete
  • Performance Management (specification focus) (stretch goal: implementation associated with Network Slicing KPI reporting)
  • Integration 
    • Integrate External API/NBI within ONAP DMaap for authenticated topics ( Adrian )
    • Integrate External API/NBI with AAF for security enhancement, introduce https support  ( Matthieu )

Use Cases

The existing use cases are still going to be supported ( BBS, CCVPN ) and additional use cases will be supported for the Frankfurt Release (as defined by the Control loop sub committee and TSC).

5G Network Slicing Use case is a new use case which have plans to use External API Service Order APIs to Create, Delete and modify Communication Services. The hope is to reuse existing Service Order APIs. Some enhancements may be needed, mainly in the ability to modify a service ( updateType, pending support from SO ) plus allowing serviceType to be an optional parameter in the Service Order ( used in AAI ). 

Minimum Viable Product

• Documentation of User Stories; Use Cases and Interactions (e.g., swagger ); 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.

Epics

Stories

Longer term Roadmap

Indicate at a high level the longer term roadmap. This is to put things into the big perspective.

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

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.

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, DMaaP 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.

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

Third Party Products mean products that are mandatory to provide services for your components. Development of new functionality in third party product may or not be expected.
List the Third Party Products (OpenStack, ODL, RabbitMQ, ElasticSearch,Crystal Reports, ...).

In case there are specific dependencies  (Centos 7 vs Ubuntu 16. Etc.) list them as well.

Testing and Integration Plans

Provide a description of the testing activities (unit test, functional test, automation,...) that will be performed by the team within the scope of this release.

Describe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.

Potential Test Cases for External API include:

• BSS/OSS retrieves Service Models
• BSS/OSS orders a new Service.
• BSS/OSS subscribes to Service order tracking status notifications.
• BSS/OSS retrieves Service Inventory

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

This section is optional and may be used to document internal milestones within a project team or multiple project teams. For instance, in the case the team has made agreement with other team to deliver some artifacts on a certain date that are not in the release milestone, it is erecommended to provide these agreements and dates in this section.

It is not expected to have a detailed project plan.

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

Note

The Documentation project will provide the Documentation Tool Chain to edit, configure, store and publish all Documentation asset.

https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/index.html

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.