DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning reviewMilestone.
| Info | ||
|---|---|---|
| ||
Use the "Copy and Paste the content below into your wiki release root directory. |
...
| 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 | Either Incubation, Core, Mature. Refer to ONAP Charter, section 3.3 Project Lifecycle for details on Project Lifecyclefurther information |
| Participating Company | List the company participating in this release. At least 3-4 organizations, including an operator are expectedrecommended. |
Scope
What is this release trying to address?
Describe the problem being solved by this release
...
Requirements
Describe the use case this release is targeted for (better if reference to customer use caserequirements).
Minimum Viable Product
Describe the MVP for this release.
...
List the functionalities that this release is committing to deliver .
...
| title | Info |
|---|
List the functionalities proposed for this release.
Add one row for each functionality.
In Scope column, indicate if the functionality is IN (for sure it will be delivered) or OUT (the functionality has been discussed, and decision was to NOT deliver the functionality in this release).
...
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 server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox and issuetype in (epic) serverId 425b2b0a-557c-3c0c-b515-579789cceedb
Stories
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox and issuetype in (story) serverId 425b2b0a-557c-3c0c-b515-579789cceedb
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.
| Deliverable Name | Deliverable Description |
|---|---|
| To fill out | To fill out |
...
List all sub-components part of this release.
Activities related to sub-component components must be in sync with the overall release.
Sub-components are repositories and are consolidate consolidated in a single centralized place. Edit the repository table Release Components name for your project in the centralized page.
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.
Indicate where your project fit within the ONAP Architecture 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.
Platform Maturity
Please fill out the centralized wiki page: Frankfurt Release Platform Maturity
API Incoming Dependencies
List the API this release project is expecting from other releasesprojects.
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 Functionality 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) |
|---|---|---|---|---|
| To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out | Link toward the detailed API description |
API Outgoing Dependencies
API this release project is delivering to other releasesprojects.
| 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 | 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, ODL, OPNFV ...).
| Name | Description | Version |
|---|---|---|
| To fill out | To fill out | To fill out |
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 with within the overall OPEN-O ONAP system.
Confirm that resources have been allocated to perform such activities.
The Release lifecycle accounts for an Testing and Integration Review where detailed plan are expected.
This activity must be in sync with Release Integration Review milestone (RC0).
Projects may apply for a system test waiver if they think they have top-level features not requiring system test or covered by other top-level features test.
Projects must specify whether they plan to use Open-O CI infrastructure for system test. It is recommended to use the Open-O CI infrastructure unless there is some HW or SW resource that cannot be installed there. Projects running system test in external Labs are required to report system test results in a timely fashion after release creations, e.g., weekly, RC, and formal releases.
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 the 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 defects.Please refer to Frankfurt Defect Status
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).
...
Please update any risk on the centralized wiki page - Frankfurt Risks
Resources
Fill out the Resources Committed to the Release centralized page.
Resources
Resources assigned to project are consolidated in a single place. Edit all the table with the ALL information, that helps to expedite Linux Foundation operations.
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 that the team agreed on.Alsowithin 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.
...
| Date | Project | Deliverable |
|---|---|---|
| To fill out | To fill out | To fill out |
Development Practices
...
Documentation, Training
Please update the following centralized wiki: Frankfurt Documentation
That includes
- Team contributions to the specific document related to he project (Config guide, installation guide...).
- 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 OPEN-O 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 OPEN-O 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 table within the [[Free_and_Open_Source_Software#Project_Licenses| Master Project License Table]].
Documentation, Training, Tutorial
- 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 | ||
|---|---|---|
| ||
It is expected all materials to be published directly either in the wiki or in OPEN-O website. Do not provide deliverable in PDF, powerpoint or word documents (these format are not easy to edit and lead to versioning issues). |
Board policy (including IPR)
Indicate if the release meets the Board policy.
Release key facts
project table available at Project FOSS.
Charter Compliance
The project team comply with the ONAP CharterProvide a link toward to Resources and Repository section of your project.