- 1 Overview
- 2 Scope
- 3 Release Deliverables
- 4 Sub-Components
- 5 Architecture
- 6 Testing and Integration Plans
- 7 Gaps
- 8 Known Defects and Issues
- 9 Risks
- 10 Resources
- 11 Release Milestone
- 12 Team Internal Milestone
- 13 Documentation, Training
- 14 Other Information
Enter the name of the project
|Target Release Name||Guilin|
|Project Lifecycle State||Incubation|
|Participating Company||China Mobile, Huawei，China Telecom|
What is this release trying to address?
The Usecase-UI Guilin release has following primary objectives:
1. Supporting use cases identified by ONAP and integration:
E2E Network Slicing: KPI Monitoring
Transport Slicing for Guilin Release
POC: Support for Intent-based Network
2. UUI enhancement and new features:
Describe the use case this release is targeted for (better if reference to customer use case).
Describe the use case this release is targeted for (better if reference to customer requirements).
Minimum Viable Product
Usecase-UI will include the necessary subcomponents supporting the primary objectives: supporting the use cases and meeting platform maturity goals.
- UUI BE Component for supporting KPI Monitoring and Transporting Slicing
- UUI FE Component for supporting KPI Monitoring and Transporting Slicing
- UUI FE Component for providing the entry for IBN system
- UUI BE Component for receiving the IBN data
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.
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.
|Source Code||Source code for all UUI components|
|Maven Artifacts||Maven Artifacts for all UUI components|
|Docker Containers||Docker container associated with UUI components|
|Documentation||UUI detailed documentation|
List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.
Sub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.
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.
Indicate where your project fit within the ONAP Archiecture diagram.
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.
Please fill out the centralized wiki page: Guilin Release Platform Maturity
API Incoming Dependencies
List the API this project is expecting from other projects.
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 Definition Date
API Delivery date
API Definition link (i.e.swagger)
|Portal Platform API||API for integration of portal applications|
Catalog API (SDC)
API to read the NS and VNF Catalog
API for NS instantiation and termination
API for registration and use of micro-services bus
|Microservice Bus API Documentation|
API for getting inventory and image management
|AAI REST API Documentation|
|VF-C API||API for NS instantiation and termination|
|DataLake API||API for FCAPS (VNF/VM monitoring)|
|External API||API for external data|
|IBN API||API for IBN data to get NLP processing result|
API Outgoing Dependencies
Third Party Products Dependencies
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.
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.
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).
|To fill out||To fill out||To fill out|
Fill out the Resources Committed to the Release centralized page.
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.
- 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.
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.
The project team comply with the ONAP Charter.