...
...
...
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 | Amsterdam Release |
| Project Lifecycle State | Incubation |
| Participating Company | AT&T, Huawei, VMWare & VMWareAccenture |
Scope
What is this release trying to address?
In Amsterdam Release, DMaaP provides a platform for high performing and cost effective data movement services that transports and processes data from any source to any target with the format, quality, security, and concurrency required to serve the business and customer needs.
Use Cases
...
Use Case: Residential Broadband vCPE (Approved)
Minimum Viable Product
- Message Router (MR) - MR is responsible for transporting messages. The interface to DR will be exposed as a RESTful web service. The service will be built over Apache Kafka.
- Data Router (DR) - DR is responsible to provide a common framework by which data producers can make data available to data consumers and a way for potential consumers to find feeds with the data they require. The interface to DR will be exposed as a RESTful web service.
- Integrate Application Authorization framework with MR.Message Rourter.
- Integrate Application Authorization framework with Data Rourter.
- Bus Controller - Provisioning DMaaP Elements
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=dmaap 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=dmaap and issuetype in (story) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term roadmap
Support transport of messages and data. Also support real time streaming, filtering and transformation.
Release Deliverables
...
| Deliverable Name | Deliverable Description |
|---|---|
| Message Router | Source Code / Executable / Docker Image |
| Data Router | Source Code / Executable / Docker Image |
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.Micro Services Bus
Architecture
High level architecture diagram
Message Router Architecture
...
.png?version=1&modificationDate=1499446674000&cacheVersion=1&api=v2&height=250)
Data Router Architecture
.png?version=1&modificationDate=1499406993000&cacheVersion=1&api=v2&height=400)
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) | To fill out | High level description of the API | Date for which the API is reviewed and agreedTo fill out | Link toward the detailed|
|---|---|---|---|---|---|---|---|---|
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 |
|---|---|---|---|---|---|---|---|---|
| Link toward the detailed API descriptionHolmes | Holmes is intended for correlation analysis between different alarms originated from different VNFs or different layers of a certain VNF | Holmes Documentation | ||||||
| DCAE | DCAE is the umbrella name for a number of components collectively fulfilling the role of Data Collection, Analytics, and Events generation for ONAP | DCAE API | ||||||
| SDN | ||||||||
| APPC | ||||||||
| Policy | ||||||||
| A&AI |
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 | ||
|---|---|---|---|---|
| To fill out | To fill out | To fill outAJSC | microservice application sever | AJSC 5 |
| Ubuntu | OS | |||
| Docker | VM container | |||
| kafka | Messaging Framework |
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.
...
- 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.
- SonarQube will be used to test coverage report.
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 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.
...
| 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.