...

...

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
      
      • 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
  • 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 choosen 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
    • 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
  • 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  ( Matthieu )

Use Cases

• TSC Must Have Requirements for ExtAPI - as per 

  Jira
  server ONAP JIRA serverId 425b2b0a-557c-3c0c-b515-579789cceedb key EXTAPI-344

  • Document current upgrade component strategy (TSC must have)  -  to be covered by 

    Jira
    server ONAP JIRA serverId 425b2b0a-557c-3c0c-b515-579789cceedb key EXTAPI-353

  • SECCOM Perform Software Composition Analysis - Vulnerability tables (TSC must have)
  • SECCOM Password removal from OOM HELM charts (TSC must have) To be covered by 

    Jira
    server ONAP JIRA serverId 425b2b0a-557c-3c0c-b515-579789cceedb key EXTAPI-352

  • SECCOM HTTPS communication vs. HTTP (TSC must have) - to be covered by 

    Jira
    server ONAP JIRA serverId 425b2b0a-557c-3c0c-b515-579789cceedb key EXTAPI-255

• Deliver increased interoperability between ONAP and External Systems ( e.g. Service Catalog Notifications ) 

  Jira
  server ONAP JIRA serverId 425b2b0a-557c-3c0c-b515-579789cceedb key EXTAPI-99

  
  
  • 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
    • Operation Domain Manager ( stretch goal ) specification focus around supporting POST of partner ServiceSpecification 

      Jira
      server ONAP JIRA serverId 425b2b0a-557c-3c0c-b515-579789cceedb key EXTAPI-351

      (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_.
• Continue to enhance ONAP External APIs exposed to BSS/OSS (e.g. Increase support for SO Service APIs , macro mode)
  • Service Ordering
    
    • Add Support for serviceOrder API for Service Instantiation via macro mode in 

      Jira
      server ONAP JIRA serverId 425b2b0a-557c-3c0c-b515-579789cceedb key EXTAPI-258

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

      Jira
      server ONAP JIRA serverId 425b2b0a-557c-3c0c-b515-579789cceedb key EXTAPI-337

      
      
      • 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
    • 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 
    • ( stretch goal ) Specification work on how to 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
  • Performance Management (stretch goal ) specification focus: specification work associated with Network Slicing KPI reporting.
  • Operation Domain Manager ( stretch goal ) specification focus around supporting POST of partner ServiceSpecification 

    Jira
    server ONAP JIRA serverId 425b2b0a-557c-3c0c-b515-579789cceedb key EXTAPI-351

  • 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 ). Wipro has taken ownership of 

Impact assessment completed by Adrian, updates only to support Service Ordering considered in Frankfurt timescale. 

Platform Maturity

 Platform Maturity (i.e., S3P items)  Frankfurt Release Platform MaturityThe existing use cases are still going to be supported and additional use cases will be supported for the Frankfurt Release (as defined by the Control loop sub committee and TSC). Network Slicing Use case is a new use case which have plans to use External API Service Order APIs.

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.

...

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

...

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.

...

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.

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.

...

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

...

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

...