Overview

Project Name	Enter the name of the project
Target Release Name	Guilin Release
Project Lifecycle State	Incubation.( 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

Scope	Priority	Committer Lead	Resources Committed	Epic	Dependencies
TSC Must have	high	Adrian OSullivan	Adrian O'Sullivan, Priyadharshini B	EXTAPI-465 - Getting issue details... STATUS

E2E Network Slicing - EXTAPI-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

Macromode for Guilin, EXTAPI-258 - "Macro" mode OPEN Former user (Deleted) - Support for when SDC instantiationType = macro

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 EXTAPI-450 - Getting issue details... STATUS

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

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

RANK #1 - Must Have

EXTAPI-446 - Getting issue details... STATUS

Contributors : Huawei

REQ-366 - Containers must crash properly when a failure occurs TO DO

RANK #1 - Must Have

EXTAPI-466 - Getting issue details... STATUS

Contributors : Huawei, Wipro, Orange

REQ-365 - Containers must have no more than one main process TO DO

RANK #1 - Must Have

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : Huawei
already DONE in previous release

REQ-380 - ONAP container repository (nexus) must not contain upstream docker images TO DO

RANK #1 - Must Have

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : Huawei
already DONE in previous release

REQ-379 - ONAP projects must use only approved and verified base images for their containers TO DO

RANK #1 - Must Have

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : Huawei
already DONE in previous release - use of standard base java 11 image for nbi

REQ-373 - ONAP must complete update of the Python language (from 2.7 -> 3.8) TO DO

RANK #1 - Must Have

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

N/A for EXTAPI (EXTAPI doesn't use python)

REQ-362 - All containers must run as non-root user TO DO

RANK #1 - Must Have

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : Huawei
already DONE in previous release

REQ-361 - Continue hardcoded passwords removal TO DO

RANK #1 - Must Have

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : Huawei
already DONE in previous release

REQ-349 - Each ONAP project shall define code coverage improvements and achieve at least 55% code coverage TO DO

RANK #1 - Must Have

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : All (currently at 65%)
Will plan to keep 65%+

REQ-351 - ONAP must complete update of the java language (from v8 -> v11) TO DO

RANK #1 - Must Have

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : Huawei
already DONE in previous release

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

REQ-358 - No root (superuser) access to database from application container TO DO

RANK #2 – Continuity

Key	Summary	T	Updated	Assignee	P	Status

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)

REQ-340 - ONAP to support Multi - tenancy TO DO

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : ?

REQ-374 - ONAP shall use STDOUT for logs collection TO DO

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : ?

REQ-369 - Replace nfs share with storage class as a default deployment option TO DO

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : ?

REQ-364 - Replace NodePorts with ingress controller as a default deployment option TO DO

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : ?

REQ-360 - Application config should be fully prepared before starting the application container TO DO

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : ?

REQ-350 - Each ONAP project shall improve its CII Badging score by improving input validation and documenting it in their CII Badging site. TO DO

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : ?

REQ-359 - Container rootfs must be mounted readOnly TO DO

Key	Summary	T	Updated	Assignee	P	Status

No issues found Refresh

Contributors : ?

Epics

key	summary	type	created	updated	due	assignee	reporter	priority	status	resolution

Refresh

Stories

key	summary	type	created	updated	due	assignee	reporter	priority	status	resolution

Refresh

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

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.

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.

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 DES

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	Targeted Level for current Release	Comments
Performance	0	0 -- none 1 – baseline performance criteria identified and measured 2 & 3 – performance improvement plans created & implemented
Stability	0	0 – none 1 – 72 hours component level soak w/random transactions 2 – 72 hours platform level soak w/random transactions 3 – 6 months track record of reduced defect rate
Resiliency	0	0 – none 1 – manual failure and recovery (< 30 minutes) 2 – automated detection and recovery (single site) 3 – automated detection and recovery (geo redundancy)
Security	1	0 – none 1 – CII Passing badge + 50% Test Coverage 2 – CII Silver badge; internal communication encrypted; role-based access control and authorization for all calls 3 – CII Gold
Scalability	0	0 – no ability to scale 1 – single site horizontal scaling 2 – geographic scaling 3 – scaling across multiple ONAP instances
Manageability	0	1 – single logging system across components; instantiation in < 1 hour 2 – ability to upgrade a single component; tracing across components; externalized configuration management
Usability	0	1 – user guide; deployment documentation; API documentation 2 – UI consistency; usability testing; tutorial documentation

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 Name	API Description	API Definition Date	API Delivery date	API Definition link (i.e.swagger)
SDC: Catalog API	Exposes Service Catalog	TBD	TBD	https://lf-onap.atlassian.net/wiki/display/DW/SDC+API
SO: Service Instantiation API	Requests for Service Instantiation	TBD	TBD
AAI: Service Inventory API	Query for Service Inventory	TBD	TBD
DMaaP: Events API	Query for AAI_EVENTS and SDC Distribution Events	TBD	TBD

API Outgoing Dependencies

API this release is delivering to other releases.

API Name	API Description	API Definition Date	API Delivery date	API Definition link (i.e.swagger)
ExtAPI: Service Catalog	External Service Catalog API	TBD	TBD	TBD
ExtAPI: Service Ordering	External Service Ordering API	TBD	TBD	TBD
ExtAPI: Service Inventory	External Service Inventory API	TBD	TBD	TBD

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

Name	Description	Version
Springboot	Java Platform Framework	TBD
MariaDB	MySQL open fork
MongoDB	Mongo Database

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.

Gaps identified	Impact
TBD	TBD

Known Defects and Issues

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

type	key	summary	assignee	reporter	priority	status	resolution	created	updated	due

Refresh

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

Risk identified	Mitigation Plan	Contingency Plan
TBD	TBD	TBD

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.

Date	Project	Deliverable
TBD	TBD	TBD

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.