Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Frankfurt |
Project Lifecycle State | Incubation. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
Participating Company |
Scope
What is this release trying to address?
- Addressing one of the long term goal in simplifying the onboarding experience for MS in DCAE. Introducing new MicroService, Onboarding & Design Platform in DCAE for Frankfurt, which will replace DCAE-DS currently under SDC
- Policy Integration : Enable update flow support via Dmaap
- Acumos-DCAE Adapter Integration
- Support ONAP usecases, functional requirement targeted for Frankfurt
- Addressing DCAE back logs + security fixes
Non-Functional Requirement
Platform Maturity
Platform Maturity (i.e., S3P items) https://wiki.onap.org/display/DW/Dublin+Release+Platform+Maturity
Green color → Target level ( details see Platform Maturity below)
- Performance: Level 1
- Stability: Level 2 (stetch with new ~52% coverage requirement for Dublin)
- Resiliency: Level 2
- Security: Level 1+
- Scalability: Level 1
- Manageability: Level 1+
- Usability: Level 2
Minimum Viable Product
The MVP of DCAE will include the necessary subcomponents supporting the primary objectives: meeting platform maturity goals and supporting the use cases.
- Cloudify Manager
- Consul (deployed/managed by OOM)
- DeploymentHander
- Policy-Handler
- ServiceChangeHandler
- Inventory-API
- Postgres
- ConfigBinding Service
- Dashboard
DCAE Service specific components
- VESCollector
- TCA (Analytics application)
- PRH
- HV_VES
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
Stories
Longer term roadmap
DCAE is the collection and analytics platform serving ONAP. Improving upon the DCAE MS catalog to add new services for data collection, analytics and the number of open/close control loops.
Other long term goal includes below
- PNDA integration and facilitating application deployment via Helm.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
---|---|
Component spec | All ms added into DCAE should provide meta data representation of the component itself; will be used to generate design flow under MOD and enable blueprint generation |
blueprints | Executable/SourceCode |
plugins | SourceCode |
cli | SourceCode/Tool/Documentation |
deployment-handler | SourceCode/Docker image |
servicechange-handler | SourceCode/Docker image |
inventory-api | SourceCode/Docker image |
policy-handler | SourceCode/Docker image |
configbinding | SourceCode/Docker image |
ves | SourceCode/Docker image |
snmptrap | SourceCode/Docker image |
tca | SourceCode/jar/Docker image |
hv-ves-collector | SourceCode/jar/Docker image |
data-file-collector | SourceCode/jar/Docker image |
prh | SourceCode/jar/Docker image |
Sub-Components
List all sub-components part of this release. Activities related to sub-components must be in sync with the overall release.
Sub-components are repositories and are consolidated in a single centralized place. Edit the Resouce and Repositories in the centralized page.
In addition to existing platform/service component, following new components are targeted for Dublin.
Deliverable | Repository | Maven Group ID | Components Description |
restconf | dcaegen2/collectors/restconf | org.onap.dcaegen2.collectors.restconf | RESTConf Collector |
son-handler | dcaegen2/services/son-handler | org.onap.dcaegen2.services.son-handler | SON-Handler MS |
pm-mapper | dcaegen2/services/pm-mapper | org.onap.dcaegen2.services.pm-mapper | Mapper to process files from DR and transform to VES |
tca-gen2 | dcaegen2/analytics/tca-gen2 | org.onap.dcaegen2.analytics.tca-gen2 | Standalone(SA) TCA |
mapper | dcaegen2/services/mapper | org.onap.dcaegen2.services.mapper | Mapper Micro Services for snmp traps/restconf input to VES |
heartbeat | dcaegen2/services/heartbeat | org.onap.dcaegen2.services.heartbeat | Missing Heartbeat Micro Services |
ONAP Dependencies
List the other ONAP projects you depend on.
DCAE depends on the the following components as part of the general ONAP architecture:
- AAI: DCAE MS retrieves and updates VNF data from/to AAI
- DMaaP: Message bus for communication with other components in the solution
- Policy - For managing application configuration policy
- CLAMP - For CL flow related MS instantiation and configuration
- OOF - For SON handler support
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.
TBA
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 | 1 | 1+ (Dublin recommendation 2 - cannot be committed due to Resource constraint) |
| |
Stability | 2 | Level 2 (Stetch with new ~52% coverage requirement for Dublin) Level 2 - Dependent on integration team support |
| |
Resiliency | 2 | 2 |
| |
Security | 1 | 1+ (Dublin recommendation 2 - cannot be committed for following reason)
|
| |
Scalability | 1 | 1 |
| |
Manageability | 1 | 1+ (Dublin recommendation 2 - cannot be committed for following reason)
|
| |
Usability | 1 | 2 (STRETCH GOAL- based on resource availability) |
|
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) |
---|---|---|---|---|
SDC model distribution API | API for retrieving TOSCA model of close loop | Currently Available | To fill out | Link toward the detailed API description |
Policy Engine | API for retrieving configuration policy updates | Currently Available | Currently Available | NA |
A&AI | API invoked for information enhancements | Currently Available | Currently Available | |
DMaaP Message Router | API for topic publish / subscribe | Currently Available | Currently Available | |
DMaaP Bus Controller | DMaaP Bus Controller is a part of DMaaP that provides topic provisioning; this is the API for topic provisioning. | Currently Available | Currently Available | |
OOF | PCI Optimization API http://{OOF-host}:{port}/api/oof/v1/pci http://{pcims-host}:{port}/callbackUrl Call back URL for SON-MS (to provide PCI optimization results) | Currently Available | Currently Available | |
ConfigDB (SDNC) | http://{ConfigDB-host/IP}:{port}/SDNCConfigDBAPI/getNbrList/{cellId}/{ts} (Get neighbor list for a cell Id) http://{ConfigDB-host/IP}:{port}/SDNCConfigDBAPI/getPnfName/{cellId}/{ts} (Get the PNF name for a cell Id) | Currently Available | Currently Available |
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) |
---|---|---|---|---|
VES Ingestion | API for VNFs to send VES data | Currently Available | R3 | |
DCAE Deployment Handler | NB API for invoking the deployment of DCAE subcomponents | Currently Available | R3 | |
DCAE Inventory | API for Add/Delete DCAE copy's TOSCA models | Currently Available | R3 | |
Healthcheck | API for querying DCAE component healthcheck | Currently Available | R4 |
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 |
---|---|---|
Cloudify Manager | ||
Consul | ||
CDAP | ||
PNDA | ||
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.
- Unit Test addition will be enforced part of new code submission
- CSIT tests will continue to be supported for existing components
- Pairwise testing will be done in the WindRiver Dev lab similar to what was done in last release
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.
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 |
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.
It is not expected to have a detailed project plan.
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.