...
Project Name | Enter the name of the project |
---|---|
Target Release Name | Casablanca |
Project Lifecycle State | Incubation. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
Participating Company | AT&T, Cloudify Nokia, NokiaEricsson, Tech Mahindra, Ericsson, Cisco |
Scope
What is this release trying to address?
DCAE Casablanca release has following primary objectives:
1. Improving platform maturity goals
2. Supporting use cases identified by ONAP and integration.
3. Adding to mS suite of collectors and event processors
Use Cases
From R3
TBD
From R2:
- VNF Scale Out: Reuse capability/components for R1 use cases. No additional impact.
- Hardware Platform Enablement In ONAP No DCAE impact needed for supporting this use case. Will follow and plan how to use in future release (e.g. additional collection and analytic).
From R1:
Following new services will be introduced for R3
- High-Volume VES collector microservice (under 5G/performance analysis and optimization)
- File collector microservice (under 5G/performance analysis and optimization) **Has dependency on DMaaP project for DataRouter delivery
- PM Mapper microservice (under 5G/performance analysis and optimization) **Has dependency on DMaaP project for DataRouter delivery (Stretch Goal, not currently committed for Casablanca)
- Standalone TCA microservice
In addition, DCAE team will work on following enhancement as Stretch Goal (not currently committed for Casablanca due to resource constraint / external dependencies /unclear requirement )
- (S3P:security) Buscontroller integration for dynamic topic provisioning and AAF based role setting. **Has dependency on DMaaP project for BusController delivery
- (S3P:Performance) Performance optimization
- VESCollector
- TCA (new TCA service independent of CDAP will be contributed for R3).
- VES
6.0upgrade support (Updated 07/31/18 - VES 7.0.1 will be supported in R3 and will replace 6.0 originally planned)- Primarily VES Collector updates for new domains and transformation (Security requirement for mutual TLS needs further clarification)
- DCAE onboarding tool (dcae_cli) enhancement and environment support
- (S3P: Maintainability) Logging format compliance
- (S3P: Resiliency) Multi-site support **Has dependency on OOM Team
- (S3P: Security) Securing api/interface and authorization via AAF (Need further clarification/support from Security/AAF team - 1) CADI library not available for Python 2) Consistent solution for AAF integration not identified (security proposal has many items WIP) 3) Process of AAF certificate distribution in K8S for components not defined and esp for components interfacing with external to ONAP)
- Following R2 items (descoped due to time/resource constraint) will be continued to enhanced for platform integration/S3P needs
- Mapper MS
- Heartbeat MS
- PNDA Integration prep-work
Use Cases
DCAE will provide support for the following use cases, currently planning on test support with no code changes expected:
DCAE will support the following functional requirements listed on the Casablanca Release Requirements page:
- 5G/PNF
Partial Commit - Support for new collector and services for processing highvolume RAN measurement and bulk data file processing - Scaling - Test only (No additional development expected from DCAE to support this requirement)
- 5G/PNF
- vFW/vDNS,
- Residential Broadband vCPE, vVoLTE
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
DCAE Service specific components
- VESCollector
- TCA (Analytics application)
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 server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=dcaegen2 and issuetype in (epic) and fixversion='
...
Casablanca Release' 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=dcaegen2 and issuetype in (story) and fixversion = '
...
Casablanca Release' serverId 425b2b0a-557c-3c0c-b515-579789cceedb
Longer term roadmap
DCAE is the collection and analytics platform serving ONAP. The value of DCAE lies in the number of types of data being collected, the number of analytics algorithms, the number of open/close control loops, and how well/easy they are supported for ONAP uses.
Long term roadmap will include support for more analytics platforms (e.g. PDNA, Flink, Prometheus, etc); more collection apparatus.
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 models in SDC and 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 |
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.
TBD
...
In addition to existing platform/service component, following new components are targeted for R3
Deliverable |
Repository | Maven Group ID | Components Description |
data-file-collector |
dcaegen2/collectors/datafile | org.onap.dcaegen2 |
.collectors |
.datafile |
Data File collector | ||
hv-ves-collector | dcaegen2/collectors/hv-ves | org.onap.dcaegen2 |
.collectors |
.hv-ves | High Volume VES Collector |
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 |
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.
TBD (add new R3 arch diagram with new components and interface)
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 |
2(stretch) |
| |
Stability |
2 | 2 |
| |
Resiliency |
2 |
2 |
| |
Security |
1 | 1 Recommendation for Casablanca is Level 2; however, Level 2 requirements are unclear and cannot be committed to. Securing api/interface and authorization via AAF (Stretch Goal, not currently committed for Casablanca due to following 1) CADI library not available for Python 2) Consistent solution for AAF integration not identified (security proposal has many items WIP) 3) Process of AAF certificate distribution in K8S for components not defined and esp for components interfacing with external to ONAP) Buscontroller integration for dynamic topic provisioning and AAF based role setting. **Dependency on DMaaP project for BusController delivery (Stretch Goal, not currently committed for Casablanca) |
|
Scalability |
1 | 1 Mutli-site support **Dependency on OOM Team (Stretch Goal, not currently committed for Casablanca) |
| |
Manageability |
1 | 1 Recommendation for Casablanca is Level 2; however, Level 2 requirements are unclear (independent upgrade) and cannot be committed to. |
| ||
Usability | 1 | 1 Recommendation for Casablanca is Level 2; however, Level 2 requirements are unclear (related to tutorial documentation) and cannot be committed to. |
|
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 | To fill out | Link toward the detailed API description | |
Policy Engine | API for retrieving configuration policy updates | |||
A&AI | API invoked for information enhancements | |||
DMaaP Message Router | API for topic publish / subscribe | |||
DMaaP Bus Controller | DMaaP Bus Controller is a part of DMaaP that provides topic provisioning; this is the API for topic provisioning. (TBD based on AAF availability) |
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 | Date for which the API is reviewed and agreed | To fill out | Link toward the detailed API description |
DCAE Deployment Handler | NB API for invoking the deployment of DCAE subcomponents | |||
DCAE Inventory | API for Add/Delete DCAE copy's TOSCA models |
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 |
---|---|---|
OpenStack | ||
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.
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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
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.