The content of this template is expected to be fill out for M1 Release Planning Milestone.
Info | ||
---|---|---|
| ||
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki. |
Table of Contents | ||
---|---|---|
|
Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Enter the name of the release you are targeting to deliver |
Project Lifecycle State | Planning |
Participating Company | China Mobile, AT&T, ZTE, Huawei |
Scope
What is this release trying to address?
Describe the problem being solved by this release
Realizing full life cycle management and FCAPS of VNF and NS.
Features and Functionality for First Release:
- Full life cycle management for NS
- Full life cycle management and FCAPS for VNFs
- Providing the integration specifications for Policy/SO/DCAE/Use case Portal/VID/Vendor VNFM/EMS/A&AI/Mutil-VIM
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).
Minimum Viable Product
Describe the MVP for this release.
Basic LCM for NS
Basic LCM and FCAPS for VNFs
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.
Functionality Name | In or Out | Priority | Stretch |
NS LCM | IN | H | NS instance creation, NS instance termination |
VNF LCM(GVNFM) | IN | H | VNF deployment, termination according to the VNF information model |
VNF FCAPS | IN | M | Collection fcaps data from the EMS |
Resource Granting | IN | H | Grant the resources requested from VNFMs |
VNFM Integration | IN | H | Integration with specific VNFMs of vendors to deploy commercial VNFs |
VNF Integration(GVNFM) | IN | H | Integration with the VNF |
Interface provided | IN | H | Provide restful interfaces to Policy/SO/VID/portal |
NS LCM | IN | M | NS instance healing |
VIM Integration | IN | H | Integration with multi VIMs via Multi-VIM. |
NS LCM | OUT | M | NS instance scaling |
Resource Granting | OUT | M | Intelligent monitoring, allocation and reservation resources based on the requirement of VNFs |
A&AI Integration | In | M | Integration with A&AI |
SDC Integration | In | M | Integration with SDC |
...
Epics&Stories(draft)
NS Package Management
NS Package Onboard
Delete NS Package
Show NS Package
NS package management integration with SDC
VNF Package Management
VNF Package Onboard
Delete VNF Package
Show VNF Package
VNF package management integration with SDC
NS Deployment
NS instantiation workflow
NS Instantiation integration with parser
NS Instantiation via ONAP Model
NS Instantiation integration with SO
NS Instantiation integration with Usecases Portal
NS Instantiation integration with A&AI
NS Instantiation integration with S-VNFM
NS Instantiation integration with G-VNFM
NS Instantiation integration with multi-VIM
NS Termination
NS Termination workflow
NS Termination integration with Usecases Portal
NS Instantiation integration with SO
NS Termination integration with A&AI
NS Termination integration with S-VNFM
NS Termination integration with G-VNFM
NS Termination integration with multi-VIM
VNF Deployment
VNF instantiation workflow
VNF Instantiation integration with parser
VNF Instantiation via ONAP Model
VNF Instantiation integration with A&AI
VNF Instantiation integration with multi-VIM
VNF Instantiation integration with S-VNFM
VNF Instantiation integration with VNF
VNF Resource Granting for VNF Instantiation
VNF Termination
VNF Termination workflow
VNF Termination integration with A&AI
VNF Termination integration with multi-VIM
VNF Termination integration with S-VNFM
VNF Resource Granting for VNF Termination
NS Autohealing
NS Healing
Integration with S-VNFM
Integration with Policy
Fault
Fault collect
Integration with DCAE
Epics
Jira | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Stories
Jira | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
Improve NS LCM operations
Nested NSs.
Improve VNF LCM operations
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
NS LCM | NS lifecycle management |
VNF Fcaps | Collect fcaps data from the EMS |
NS Resource Management | NS Visualize resources and instantiations resources management |
VNFM Drivers | VNFM drivers, including specific VNFM drivers |
VNF LCM(GVNFM) | VNF lifecycle management |
VNF Resource Management?GVNFM? | VNF Virtual Resource Management |
VNF Init Configuration(GVNFM) | VNF Init Configuration and Management |
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.
ONAP Dependencies
List the other ONAP projects your depends on.
Policy
DCAE
SO
Use case Portal
VID
Multi-VIM
A&AI
SDC
Modeling
MSB
OOM
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.
The color coding is as following:
- Green color of FBs (NFVO, G-VNFM/S-VNFM and EM) and interfaces (IFA013/SOL005, IFA007/SOL003, IFA008/SOL002, IFA006/OpenStack) implies full compliancy with ETSI NFV Release-2 specifications.
- Blue color of interface (3GPP Itf-N – northbound of EM) implies full compliancy with 3GPP SA5 specifications
- Yellow color of FBs (AA&I, MSO, DCAE and Policy) and interfaces (ECOMP message bus) implies un-changed ONAP message bus (same as used by APP-C)
- White color of interfaces implies that this particular interface is typically not standardized and remains proprietary
- Pink color of FB (ONAP Adaptor) shows the actual scope of the VF-C open source development effort
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) |
Catalog API (SDC) | API to read the NS and VNF Catalog | |||
Parser API | API for parsering TOSCA file | |||
Micro-services bus API | API for registration and use of micro-services bus | |||
Multi-vim API | API to allocate resource to VIM | |||
DCAE VES collector SB API | API to push vnf fcaps data to VES collector | |||
A&AI API | API to store inventory |
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) |
NSLCM API Definition | Network services lifecycle management APIs | Link toward the detailed API description | ||
VNFM Driver API Definition | VNFM Driver component southbound APIs | |||
VNF LCM API Definition | provide lifecycle management APIs |
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 |
WSO2 | Workflow execution engine | |
ARIA | TOSCA Parser | |
Parser | Openstack Parser ??? |
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.
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 |
---|---|
To fill out | To fill out |
Known Defects and Issues
Provide a link toward the list of all known project bugs.
Jira | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
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 |
---|---|---|
To fill out | To fill out | To fill out |
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 |
---|---|---|
To fill out | To fill out | To fill out |
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. |
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.
Project Name:
- Proposed name for the project: Usecase UI
- Proposed name for the repository: usecase-ui
Project description:
- Usecase UI is the ONAP subsystem that provides Graphical User Interface (GUI) for operators and end-users from the point of view of use cases. As a whole project, Usecase UI requiremetns not only includes service design and run-time management (resource, performance, fault, security, configuration, etc.) for operators, but also includes self-service management for end-users.
- This project targets identifying all GUI requirements which operators and end-users need ONAP to support, coordinating GUI parts of each ONAP subsystem, filling the gaps for improving GUI functionalities for use case. All GUI functionalities of ONAP system can be well showed to satisfy the requirements from different customers.
Scope:
- The Designer Role:
- Service design (implemented by SDC)
- VNF onboarding (implemented by SDC)
- Policy design (implemented by Policy Framework)
- Closed Loop design (implemented by CLAMP)
- The Operator Role:
- Service LCM (implemented by VID portal)
- Inventory for services and resources (implemented by A&AI)
- Monitor system alarms (implemented by this project)
- Alarm correlation (implemented by Holmes)
- Show system performance (implemented by this project)
- The user Role: (Implemented by this project)
- Provide model-based vCPE instance orchestration interface
- Consume and interpret standard ONAP vCPE models
- Call service orchestration systems to configure services and VNFs in the core and at the edge
- Use inventory systesm to determine currently defined inventory for core and edge services
- End-user self-service management UI of provisioned vCPE elements
Architecture Alignment:
- How does this project fit into the rest of the ONAP Architecture?
- Usecase Ui is one of the key functional GUI blocks in the ONAP Architecture
- What other ONAP projects does this project depend on?
- Portal Platform
- DCAE
- A&AI
- VID
- SDC
- Policy Framework
- CLAMP
- How does this align with external standards/specifications?
- Usecase UI will use provide an HTTP(s) web GUI and will interface with other systems using standard protocols like REST over HTTP(s).
- Are there dependencies with other open source projects?
- N/A
Resources:
...
Names, gerrit IDs, and company affiliations of the committers
...
Names and affiliations of any other contributors
...
Other Information:
- link to seed code (if applicable)
- Vendor Neutral
- The project is vendor neutral.
- Meets Board policy (including IPR)
Use the above information to create a key project facts section on your project page
Key Project Facts
Project Name:
- JIRA project name: usecase-ui
- JIRA project prefix: usecase-ui
Repo name: usecase-ui
Lifecycle State:
Primary Contact: Tao Shen (China Mobile), Amichai Hemli (AT&T)
Project Lead: Tao Shen (China Mobile), Amichai Hemli (AT&T)
mailing list tag [Should match Jira Project Prefix]
Committers: please refer to the above table
*Link to TSC approval:
Link to approval of additional submitters: