DRAFT PROPOSAL FOR COMMENTS
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 NameEnter the name of the project | Data movement as a platform |
|---|---|
| Target Release Name | Beijing Release |
| Project Lifecycle State | Either Incubation , Core, Mature. (Refer to ONAP Charter, section 3.3 Project Lifecycle for further information) |
| Participating Company | AT&T, Tech Mahindra |
Scope
What is this release trying to address?
AAF integration with Message Router, Data Router, and Bus Controller will be added to the DMaap and some enhancements to the DMaap client.
Use Cases
The existing Amsterdam use cases are still going to be supported and additional use cases related to the DR and Bus Controller will be supported for the Beijing Release.
Minimum Viable Product
For Beijing release, the minimum viable product we are targeting is integrating AAF with the Message routerRouter, sending and receiving messages using Data router, and provisioning topics and feeds via Bus Controller.
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=sanbox 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=sanbox =DMAAP and status = "To Do" and issuetype in (story) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term roadmap
DMaaP is a premier 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.
Release Deliverables
...
| Deliverable Name | Deliverable Description |
|---|---|
AAF integration with Data Router | DMaap Git repository |
| Data Router source code | DMaap Git repository |
| Data Router library | ONAP Nexus repository |
| Data Router API description | ONAP wiki |
| Data Router Release Notes | ONAP wiki |
| Data Routee Router Documentation | DMaap Git repository |
| Bus Controller API | DMaaP Git repo |
| Bus Controller Container | ONAP Nexus repo |
| Bus Controller source code | DMaaP Git repo |
Sub-Components
As part of the Beijing release, Data Router the following components will be added to the DMaapDMaaP:
- Data Router - for file transport
- Bus Controller Provisioning API - for provisioning of topics (MR), feeds (DR) and permissions (AAF)
- Bus Controller GUI - human interface to Bus Controller Provisioning API
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 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.
Platform Maturity
Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.
| Area | Actual Level | Targeted Level for current Release | How, Evidences | Comments |
|---|---|---|---|---|
| Performance | 0 | 1 | Baseline performance criteria will be defined |
|
| Stability | 1 | 1 | 72 hours soak test with random transactions |
|
| Resiliency | 2 | 2 | K8S auto detection and recovery |
|
| Security | 0 | 21 |
| |
| Scalability | 1 | 1 | Level 1 single site horizontal scaling |
|
| Manageability | 1 | 1 | Using EELF common framework for logging |
|
| Usability | 1 | 2 | API documentation and swagger API provided |
|
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 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 descriptionAAF | Authentication and Authorization Framework | TBD | March 08 2010 | TBD |
API Outgoing Dependencies
API this project is delivering to other projects.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|
Third Party Products Dependencies
...
| Publishing | API used to post a message to the Topic | Sept 11 2017 | March 08 2018 | DMaap API |
| Subscribing | API used to subscribe a message from the Topic | Sept 11 2017 | March 08 2018 | DMaap API |
| Provisining | API for creating,deleting and listing the administrative objects | Sept 11 2017 | March 08 2018 | DMaap API (Bus Controller API) |
| Admin API | API for the admin access | Sept 11 2017 | March 08 2018 | DMaap API |
Third Party Products Dependencies
| Name | Description | Version |
|---|---|---|
| AJSC | Java services container | 1.0.0 |
| Kafka | Distributed messaging platform | 0.8.2.1 |
| Zoo Keeper | Centralized service for maintaining configuration information | 3.4.6 |
| Spring | Spring Framework | 1.4 |
| Docker | Container engine | 1.12 |
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.
...
- Unit test: Unit tests has atleast 30% code coverage.
- Functional test: Leverage the robot framework infrastructure to provide the functional test.
- Integration test: Support integration team to provide the end to end integration test.
- All the above should be automation tests run on the LF Jenkins Infrastructure.
Gaps
No gaps identified so far
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).
...
Resources
Fill out No known risks so far.
Resources
Updated 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
...
may be used to document internal milestones
...
that the team agreed on.
Also, 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,
...
provide these agreements and dates in this section.
It is not expected to have a detailed project plan.
Date
Project
Deliverable
...
3/29/2018 DMaaP DMaap - Buscontroller
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
- ...
...
| title | Note |
|---|
...
http://onap.readthedocs.io/en/latest/submodules/dmaap/messagerouter/messageservice.git/docs/Installation/Installation.html?highlight=dmaap
http://onap.readthedocs.io/en/latest/submodules/dmaap/messagerouter/messageservice.git/docs/release-notes.html?highlight=dmaap
http://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/components/dcae-cli/dmaap-connection-objects.html?highlight=dmaap
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.
...