Draft
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 deliverFrankfurt R6 |
| Project Lifecycle State | Either Incubation, Core, Mature. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information/Mature |
| Participating Company List | the company participating in this release. At least 3-4 organizations, including an operator are recommended.AT&T |
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 requirements).
Minimum Viable Product
...
Enhance to protect all update operations in Kafka
Create Kafka image using Confluent 5.3.0
Replace SASL_PLAINTEXT listeners with SASL_SSL listeners in Kafka
Create custom Zookeeper image using confluent 5.3.0
Disable the AAF using a single flag
Securing the Kafka ZNodes using ACLs
Following TSC must-haves
- Document current upgrade component strategy
- SECCOM Perform Software Composition Analysis - Vulnerability tables
- SECCOM Password removal from OOM HELM charts
- SECCOM HTTPS communication vs. HTTP
Requirements
The existing Dublin use cases are still going to be supported. We will also support 5G use case requirements.
Minimum Viable Product
Upgrade MR components to newer Confluent Community 5.3.0 Kafka and Zookeeper. Replace Kafka SASL_PLAINTEXT listeners with SASL_SSL listeners while allowing to disable AAF using a flag. Secure Kafka ZNodes using ACLs.
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) and fixVersion="Frankfurt Release" 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 issuetype in (story) and fixVersion = "Frankfurt Release" serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.
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 |
|---|---|
| To fill out | To fill out |
Sub-Components
List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.
...
| Docker image | Custom Kafka image and DMaaP images |
| Source Code | Source code of DMaaP |
| Release Note | Release note of the release |
Sub-Components
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.
...
DMaaP is a Kafka based platform that is used by various ONAP components to publish and subscribe messages with each other required for processing events.
Platform Maturity
Please fill out the centralized wiki page: Frankfurt Release Platform Maturity
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 |
|---|
...
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 outAAF | Authentication and Authorization Framework | already available | already available | Link toward the detailed API description |
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) |
|---|
| DMaaP MR API | API used to create Topics ,publish a message,subscribe to a Topic etc. | Date for which the API is reviewed and agreed | TBD | API documentation |
| DMaaP Buscontroller API | Provisioning API for management of Topics and Feeds | Date for which the API is reviewed and agreed | M2 | API documentation (ReadTheDocs) |
| DMaaP DataRouter API | API used to create feeds ,publish to this feed, subscribe to a feed | Date for which the API is reviewed and agreed |
| M2 | API documentation |
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 |
|---|---|---|
| Zoo Keeper | Centralized service for maintaining configuration information | 3.4.14 |
| Spring | Spring Framework | 4.3.18 |
| Kafka | Distributed messaging platform | 2.4.0 |
| Docker | Container engine | 18.09.x |
| AJSC | Java services container | 3.0.10 |
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 test: Unit tests has at least 50% 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
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
None currently
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.
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
Please update the following centralized wiki: Frankfurt Documentation
...
| 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.
...