DRAFT
The content of this template is expected to be fill out for M1 Release Planning Milestone.
...
| title | Info |
|---|
...
| 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 deliverAmsterdam |
| Project Lifecycle StateEither Incubation, Core, Mature. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information | Planning |
| Participating Company | List the company participating in this release. At least 3-4 organizations, including an operator are recommended.Amdocs, AT&T |
Scope
What is this release trying to address?
Describe the problem being solved by this releaseIn this release we will address the need for improving automation, permissions and instantiation flows of VNFs.
Use Cases
Describe VID will contribute to the use case this release is targeted for (better if reference to customer use case).
Minimum Viable Product
Describe the MVP for this release.following use cases:
Use Case: Residential Broadband vCPE (Approved)
VID will continue to support to the following use case:
Minimum Viable Product
- Read only "ONAP global role" permission for VID users
- Specific role assignment for components instantiations
- Change management for selected work flows (Upgrade and Configuration)
- PNF support
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
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=vid and issuetype in (epic) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Stories
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=vid and issuetype in (story) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term roadmap
...
- Fully automated deployment of new VNFs without the need of manual intervention or configuration.
- Support workflows for change management by using the SDC as a provider of workflows capabilities
- Dashboarding scheduled and ongoing change management
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
| Deliverable Name | Deliverable Description |
|---|
| VID application | Executable, Docker |
| MariaDB | SQL database scheme |
| Release documentation | ONAP WIKI pages |
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.
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.
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.
...
Components Name | Components Repository name | Maven Group ID | Components Description |
|---|---|---|---|
| asdcclient | vid/asdcclient | org.onap.vid.asdcclient | VID SDC Client library |
ONAP Dependencies
Portal - Our application is compiled with the Portal SDK and is accessed as a "tab" in the Portal web application. Any changes to this sdk may require re-compilation on our end.
A&AI - We are dependent on A&AI apis so that we can retrieve instances of already exist Services,VNFs and Modules.
AAF - We are dependent on AAF so that our new roles are managed through the Portal and role cased permissions of VID.
SDC - We are dependent on being able to integrate with the SDC API in order to receive service catalog and models
(m)SO - We are dependent on SO (MSO) so that VID will invoke creation and modification of services, VNFs and modules.
Architecture
High level architecture diagram
API Incoming Dependencies
No new API Incoming Dependency for this release.
The previous dependencies i.e.AAI, SDC, (m)SO, Portal remain unchanged.
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) | To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out
|---|---|---|---|---|---|---|---|
| NB Interface | REST API | TBD | TBD | Link toward the detailed API description |
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, ...).
| Third Party | Description | Version |
|---|---|---|
| To fill out | To fill out | To fill out |
...
| Docker | Docker container host | Latest one |
| MariaDB | SQL DB | 10.1.11 |
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.
- Unit tests are run automatically as part of every code merge.
- Once the final Docker image is compiled, it will be installed onto a Docker host and will be checked to ensure no errors occur during start-up.
- Functional testing will occur to ensure that the use cases are functioning correctly.
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 Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
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 outNone at this time | N/A | N/A |
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 recommended to provide these agreements and dates in this section.
...
| 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.
Release Key Facts
Fill out and provide a link toward the centralized Release Artifacts.