Versions Compared

Version Old Version 1 New Version Current
Changes made by

Adrian OSullivan

Adrian OSullivan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
outlinetrue

...

Scope

What is this release trying to address?

...

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyEXTAPI-344

...

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyEXTAPI-353

...


Table of Contents
outlinetrue

Overview

Project NameEnter the name of the project
Target Release NameGuilin Release
Project Lifecycle StateIncubation.( Refer to ONAP Charter, section 3.3 Project Lifecycle for further information)
Participating Company AT&T, CenturyLink, China Mobile, Huawei, Orange, Verizon, Amdocs, Ciena, Wipro, HCL, Tech Mahindra, Netcracker, MEF, TMF

Scope

What is this release trying to address

  • Support TSC must have ONAP requirements Guilin Release Requirements 
  • implements as much TSC must feature as possible


    ScopePriorityCommitter LeadResources CommittedEpic Dependencies 
    TSC Must have
    		high
    Adrian OSullivan
    Adrian O'Sullivan, Priyadharshini B

    Jira Legacy
    serverSystem Jira
    serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
    keyEXTAPI-465



  • E2E Network Slicing -   Image AddedEXTAPI-449 - E2E Network Slicing: Lifecycle management operations – standard interface OPEN  Enhancements for Service activation, deactivation, termination (based on TMF 641) 
    • Slides presented covering the NBI requirement for E2E External API Framework: 5GNetworkSlicing_ExtAPI_20200610_v1.0.pptx
      • Implementation of TMF 641 APIs for service activation/deactivation/termination. We will go ahead with the proposed approach based on last week's discussion to use ServiceState of Service object as part of EXTAPI-449
      • Specification work on (modernized) TMF 628 for "On Demand" PM collection and future mapping to DES API's


Use Cases

The existing use cases are still going to be supported ( BBS, CCVPN ) in the Guilin Release

5G E2E Network Slicing Use case have plans to use External API Service Order APIs to Create, Delete and modify ( activate / deactivate) Communication Services. There is minor changes to reuse the existing Service Order APIs to activate and deactivate Service Instances via ServiceState. 

The major impact is for the catering Performance Management and the possible inclusion of a subset of the TMF 628 API. See 

  • Slides presented covering the NBI requirement for E2E External API Framework: 5GNetworkSlicing_ExtAPI_20200610_v1.0.pptx
  • Only Specification aspects of the mapping to be covered during Guilin Release, with implementation of new API tentatively planned for Honolulu Release   
    Jira Legacy
    serverSystem Jira
    serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
    keyEXTAPI-450
     

Platform Maturity

 Platform Maturity (i.e., S3P items)  Guilin Release Platform Maturity 

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

18 Non functionals :

10 - TSC MUST HAVE (please indicate where you plan to contribute)

Requirement Epic

TSC Priority

EXTAPI Epic(s) and/or EXTAPI Story(ies)

Committed Contributors

Image AddedREQ-323 - Each project will update the vulnerable direct dependencies in their code base TO DO

RANK #1 - Must Have

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyEXTAPI-

...

446

  • Contributors : Huawei
Image AddedREQ-366 - Containers must crash properly when a failure occurs TO DO
RANK #1 - Must Have

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e

...

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyEXTAPI-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 Legacy
      serverSystem Jira
      serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
      keyEXTAPI-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_.

...

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyEXTAPI-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

...

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyEXTAPI-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

...

  • 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 

...

  • 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

...

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyEXTAPI-351

...

  • 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 

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyEXTAPI-349
 for enhancements needed. 

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 Maturity

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

...

-4fd8aff50176
keyEXTAPI-466

  • Contributors : Huawei, Wipro, Orange
Image AddedREQ-365 - Containers must have no more than one main process TO DO
RANK #1 - Must Have



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : Huawei
  • already DONE in previous release
Image AddedREQ-380 - ONAP container repository (nexus) must not contain upstream docker images TO DO
RANK #1 - Must Have



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : Huawei
  • already DONE in previous release
Image AddedREQ-379 - ONAP projects must use only approved and verified base images for their containers TO DO
RANK #1 - Must Have



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : Huawei
  • already DONE in previous release - use of standard base java 11 image for nbi
Image AddedREQ-373 - ONAP must complete update of the Python language (from 2.7 -> 3.8) TO DO
RANK #1 - Must Have



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • N/A for EXTAPI (EXTAPI doesn't use python)
Image AddedREQ-362 - All containers must run as non-root user TO DO
RANK #1 - Must Have



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : Huawei
  • already DONE in previous release
Image AddedREQ-361 - Continue hardcoded passwords removal TO DO
RANK #1 - Must Have



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : Huawei
  • already DONE in previous release
Image AddedREQ-349 - Each ONAP project shall define code coverage improvements and achieve at least 55% code coverage TO DO
RANK #1 - Must Have



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : All (currently at 65%)
  • Will plan to keep 65%+
Image AddedREQ-351 - ONAP must complete update of the java language (from v8 -> v11) TO DO
RANK #1 - Must Have



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : Huawei
  • already DONE in previous release

1 - TSC PRIORITY 2 Continuity (please indicate where you plan to contribute)

Image AddedREQ-358 - No root (superuser) access to database from application container TO DO
RANK #2 – Continuity 



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : Huawei
  • already DONE in previous release

7- TSC PRIORITY 3 PTL GO/NO GO (please indicate where you plan to contribute)

Image AddedREQ-340 - ONAP to support Multi - tenancy TO DO



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : ?
Image AddedREQ-374 - ONAP shall use STDOUT for logs collection TO DO



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : ?
Image AddedREQ-369 - Replace nfs share with storage class as a default deployment option TO DO



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : ?
Image AddedREQ-364 - Replace NodePorts with ingress controller as a default deployment option TO DO



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : ?
Image AddedREQ-360 - Application config should be fully prepared before starting the application container TO DO



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : ?
Image AddedREQ-350 - Each ONAP project shall improve its CII Badging score by improving input validation and documenting it in their CII Badging site. TO DO



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : ?
Image AddedREQ-359 - Container rootfs must be mounted readOnly TO DO



KeySummaryTUpdatedAssigneePStatus

No issues found  Refresh




  • Contributors : ?


Epics

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject = EXTAPI AND fixVersion = "Frankfurt Guilin Release" AND type = Epic
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176

...

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject = EXTAPI AND fixVersion = "Frankfurt Guilin Release" AND type = Story
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176

...

  • 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 a summary of Service Performance
  • 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

...

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
    5. Performance Mgmt API

ONAP Dependencies

List the other ONAP projects your depends on.

Dependent on APIs from SDC, SO, DMaaP, AAI and AAIDES

Architecture

High level architecture diagram

...

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.

...

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 Name

API Description

API Definition Date

API Delivery date

API Definition link (i.e.swagger)

SDC: Catalog APIExposes Service CatalogTBDTBDhttps://wikilf-onap.onapatlassian.orgnet/wiki/display/DW/SDC+API
SO: Service Instantiation APIRequests for Service InstantiationTBDTBD
AAI: Service Inventory APIQuery for Service InventoryTBDTBD
DMaaP: Events APIQuery for AAI_EVENTS and SDC Distribution EventsTBDTBD

...

Risk identified

Mitigation Plan

Contingency Plan

TBDTBDTBD

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.

...

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


Charter Compliance

The project team comply with the ONAP Charter.