Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Guilin |
Project Lifecycle State | Incubation. Refer to ONAP Charter, section 3.3 Project Lifecycle for further information |
Participating Company | AT&T, Nokia, Ericsson, Wipro, ChinaMobile, T-Mobile, Huawei? |
Scope
What is this release trying to address?
Release Focus
DCAE Focus for R7 is on following
- ONAP R7 Usecase & Functional requirement
- TSC/SECCOM MUST-HAVE requirements
- General platform optimization
- DCAE Bootstrap/CM Manager optimization (moving plugins to CM)
- MOD catalog/UI redesign (POC)
- Addressing DCAE back logs + security fixes
Guilin Usecases with DCAE impact
REQ# | Description | DCAE Commit Status | DCAE Impact Assessment | DCAE JIRA # |
REQ-345 | 5G OOF SON use case requirements for Guilin release | YES | SON-Handler enhancement. Commitment based on WIPRO support | DCAEGEN2-2312 |
REQ-342 | E2E Network Slicing requirements for Guilin release | YES | New MS introduction - DES (under DL-Handlers), Slice Analysis MS, PM-Mapper Enhancements Commitment based on WIPRO/China Mobile support | DCAEGEN2-2258 |
REQ-325 | MDONS Extension in Guilin Release | YES | 7/2 - Using VES Flow (DCAE impact is TO) | NA |
Following new services will be delivered in R7 to support REQ-342
Slice Analysis MS
Repository : https://git.onap.org/dcaegen2/services/tree/components/slice-analysis-ms
Data Extraction Service (DES)
Repository : https://git.onap.org/dcaegen2/services/tree/components/datalake-handler/des
Guilin Features with DCAE Impact
Functional Requirements
REQ# | Description | DCAE Commit Status | DCAE Impact Assessment | DCAE JIRA # |
REQ-381 | Bulk PM / PM Data Control Extension | YES | PMSH and PM-Mapper enhancements Commitment based on Ericsson | DCAEGEN2-2164 |
REQ-327 | ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES | YES | VESCollector + platform/deployment support via config-map Commitment based on Nokia | DCAEGEN2-1769 |
REQ-326 | Self Serve Control Loops | YES | MOD updates Commitment based on AT&T | DCAEGEN2-1993 DCAEGEN2-2314 (MOD-POC) |
REQ-321 | CMPv2 Enhancements for R7 | YES | DCAE Platform (k8splugin, CM/Bootstrap) Commitment based on Nokia, AT&T | DCAEGEN2-2250 |
REQ-385 | IPv4/IPv6 dual stack support in ONAP | YES | K8splugin change to support k8s 1.17+ Commitment based on Nokia | DCAEGEN2-2309 |
Non-Functional Requirement
REQ# | Description | TSC Priority | DCAE Commit Status | DCAE Impact Assesment | DCAE JIRA # |
REQ-380 | ONAP container repository (nexus) must not contain upstream docker images | MUST HAVE | YES | Add explicit references to dockerhub or nexus to all images Commitment based on Samsung, AT&T | DCAEGEN2-2322 |
REQ-379 | ONAP projects must use only approved and verified base images for their containers | MUST HAVE | Stretch-goal | HIGH RISK - Approved base images list NOT CONFIRMED + MULTIPLE DCAE COMPONENT IMPACT (RISK#5- Guilin Risks)
Commitment : Multiple companies | DCAEGEN2-2323 |
REQ-374 | ONAP shall use STDOUT for logs collection | PTL | Stretch-goal | Multiple platform components impacts (CBS, DH, PH, Cloudify not complain). (Long- Stretch goal depending on OOM team support) | DCAEGEN2-2324 |
REQ-373 | ONAP must complete update of the Python language (from 2.7 -> 3.8) | MUST HAVE | YES | Per TSC 2.7->3.8 important; 3.7-3.8 (nice to have) Except Cloudify and SNMPTrap - all other DCAE components will be migrated to 3.8. SECCOM approved exception on 7/3 (refer jira) Commitment based on T-Mobile | DCAEGEN2-2292 |
REQ-366 | Containers must crash properly when a failure occurs | MUST HAVE | YES | MEDIUM RISK - Need further assessment on DCAE components impacted (RISK#6 Guilin Risks) Commitment based on Ericsson | DCAEGEN2-2326 |
REQ-365 | Containers must have no more than one main process | MUST HAVE | YES | MEDIUM RISK - Need further assessment on DCAE components impacted (RISK#6 Guilin Risks) Exception required for Cloudify due to upstream dependency. Commitment based on Ericsson | DCAEGEN2-2327 |
REQ-364 | Replace NodePorts with ingress controller as a default deployment option | PTL | Stretch-goal | Need to be create DCAE jira if OOM team support is confirmed (may just need to update your tests to use urls instead of IPs) Resource TBD | NA |
REQ-361 | Continue hardcoded passwords removal | MUST HAVE | YES | 1) Evaluate certInitializer integration impact for DCAE-tls init container Commitment based on Orange/Samsung/AT&T | DCAEGEN2-1972 |
REQ-360 | Application config should be fully prepared before starting the application container | PTL | NO | Okay for service components (as CBS is used); Platform component should be okay. MOD - to be verified (possibly MOD/Nifi container) + Dashboard | NOT Committed |
REQ-358 | No root (superuser) access to database from application container | YES | Stretch-goal | Need further assesment. Current list of component impact - Dashboard/Inventory/TCA-gen2/heartbeat/PM-Mapper/DL-feed/Son-handler Commitment based on WIPRO/ChinaMobile | DCAEGEN2-2329 |
REQ-351 | ONAP must complete update of the java language (from v8 -> v11) | MUST HAVE | YES | MEDIUM RISK : Due to number of DCAE components impacted. (RISK#7 Guilin Risks)
Commitment : Multiple companies | DCAEGEN2-2223 |
REQ-350 | Each ONAP project shall improve its CII Badging score by improving input validation and documenting it in their CII Badging site. | PTL | Stretch-goal | DCAEGEN2-2332 | |
REQ-349 | Each ONAP project shall define code coverage improvements and achieve at least 55% code coverage | MUST HAVE | YES | Already complaint for Frankfurt components; new component/enhancement to adhere Commitment : Multiple companies | DCAEGEN2-2333 |
REQ-323 | Each project will update the vulnerable direct dependencies in their code base | MUST HAVE | YES | Commitment : Multiple companies | DCAEGEN2-2242 |
DCAE Backlog Reduction
- VESCollector Enhancements
- DCAEGEN2-1483 – Event publish order issue (stretch goal)
- DCAEGEN2-1484 - Set dynamic partitionkey (stretch goal) - AT&T
- DCAEGEN2-608 - Performance/benchmarking - Nokia
- DL Handlers Enhacements DCAEGEN2-1849 (stretch goal) - China Mobile
- DCAE Dashboard Fixes and security updates - AT&T
Inaddition adhoc platform items from backlog below are targetted for this release also.
JIRA | Description | Commit Status | Company Contribution |
DCAEGEN2-1789 DCAEGEN2-2236 | Import plugins instead of type files in blueprints (Blocks DCAEGEN2-2167 cfy validate error) | Yes | AT&T |
CCSDK-2158 | pgaas_db 1.1.0 type file refers to 1.2.0 plugin | Yes | AT&T |
DCAEGEN2-2136 | Cloudify unable to parse certain micro service policies | TBC (stretch-goal) | |
DCAEGEN2-2140 | escaped string in spec file not included on the blueprint generated | TBC | AT&T |
DCAEGEN2-2144 | bp-gen: switch ContainerizedPlatformComponent to ContainerizedServiceComponent | Yes | AT&T |
CCSDK-2325 & DCAEGEN2-2207 DCAEGEN2-2262 (bp-gen & runtime) | Cloudify plugin consolidation + nodetype name syncup | Yes | AT&T |
DCAEGEN2-2197 | runtimeAPI defaults pointing to R4 plugins (MOD) | Yes | AT&T |
DCAEGEN2-2221 | Switch to support offline install for OnboardingAPi (MOD) | TBC | |
DCAGEN2-1791 | K8s plugin - ContainerizedPlatformComponent to ContainerizedServiceComponent | Yes | AT&T |
To be created | DCAE Healthcheck container - completely dynamic (remove static) | Yes | AT&T |
DCAEGEN2-2218 | DCAE hardcodes certificates in onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0 | TBC | |
DCAEGEN2-1857 | dashboard error on logout | Yes | AT&T |
DCAEGEN2-1638 | Dashboard container optimization | TBC | |
DCAEGEN2-2022 | Improve DH install/uninstall workflow to avoid out of sync conditions with Cloudify (corresponding Dashboard change pending) | Yes | AT&T |
To be created | Plugin path/load optimization: Taking release from PATH on raw/plugin repo location (rely on version) and update bootstrap/cloudify build | TBC | |
DCAEGEN2-2215 | Allow environment variables to be passed in docker_config (k8s plugin) | Yes | AT&T |
DCAEGEN2-1786 | Eliminate use of Consul service discovery in DCAE | TBC | |
DCAEGEN2-2295 | Sonar coverage for dcaegen2/plugin | Yes | AT&T |
TBC | Helm plugin 3.0 enhancement (new contribution) | TBC | AT&T |
DCAEGEN2-2328 | Genprocessor not recovering from error (DFC spec) | Yes | AT&T |
DCAEGEN2-1864 | DCAE healthcheck improvement for MOD components | Yes | AT&T |
DCAEGEN2-2298 | Dashboard Java11 support | Yes | AT&T |
DCAEGEN2-2296 DCAEGEN2-2297 | Dashboard documentation (missing api in RTD + userguide) | Yes | AT&T |
With Guilin release, following components will be deprecated and no longer available part of ONAP DCAE deployments. Corresponding repositories will be marked as RO.
- TCA/CDAP (replaced by TCA-gen2)
- RESTConf Collector*
- VES-Mapper*
* Pending discussion with ARC/TSC
Platform Maturity
Platform Maturity (i.e., S3P items) Guilin Release Platform Maturity
Green color → Target level ( details see Platform Maturity below)
- Performance: Level 1
- Stability: Level 2
- Resiliency: Level 2
- Security: Level 1+
- Scalability: Level 1
- Manageability: Level 1+
- Usability: Level 1+
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-gen2
- PRH
- HV_VES
DCAE-MOD deployment is optional and will include following component (controlled via helm chart configuration under OOM)
- Genprocessor
- MOD/NiFI UI
- Distributorapi
- Runtimeapi
- Onboardingapi
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.
DCAE-MOD evolution and integration with CLAMP and Policy
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 and wagon files under nexus/raw |
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 |
hv-ves-collector | SourceCode/jar/Docker image |
prh | SourceCode/jar/Docker image |
dcae-mod | SourceCode/jar/Docker image/Documentation |
tca-gen2 | SourceCode/jar/Docker image |
Note: Only default platform components and bootstrapped MS is listed on table above. DCAE also include dynamic service components deployed based on usecases. For a complete set of available DCAE MS - refer https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/release-notes.html#deliverables
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 Guilin.
Deliverable | Repository | Maven Group ID | Components Description |
Slice Analysis MS | dcaegen2/services | org.onap.dcaegen2.services.sliceanalysis | Slicen Analysis MS for 5G E2E Slice usecase support |
Data Extraction service (DES) | dcaegen2/services | org.onap.dcaegen2.services.dl-handler.des | Provides api's for data-access from DL-handler maintained storage |
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.
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 |
| |
Stability | 2 | 2 |
| |
Resiliency | 2 | 2 |
| |
Security | 1 | 1+ (Most DCAE components are complaint; will address remaining in Guilin based on resource availability) |
| |
Scalability | 1 | 1 |
| |
Manageability | 1 | 1+ (Except logging, all other requirements are met) |
| |
Usability | 1 | 1+ |
|
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 |
Policy (PDP) | API to push DCAE MS configuration/policy models | Currently Available | Currently Available | |
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 | 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 Collector | API for VNFs to send VES data | Will be updated for new VES spec (7.2) | ||
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 | |
DCAE Onboarding API | API for publishing DCAE spec into MOD | Currently Available | R6 | |
DCAE Inventory | API for CLAMP to retrieve flow information | Currently Available | R6 | |
Data Extraction Service (DES) | API for data retrieval and simple computation from DL-Handler maintained storages (For R7, this will be used by DCAE components such Slice-Analyis MS) and UUI | Will be provided during M2/M3 | R7 | |
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 |
---|---|---|
NIFI | Apache NIFI | 1.9.x |
Cloudify Manager | cloudifyplatform/community | 19.01.24 |
Consul | 1.0.0 (version based on OOM) | |
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
Testing and Integration Plans
- 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 |
---|---|
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 |
---|---|---|
Cloudify support for Python 3.x not available currently, expected in by Aug 2020 timeframe. This impacts migration of Cloudify and associated plugins in Guilin (REQ-373) | Continue Frankfurt version of Cloudify and Plugins under python 2.7 | None |
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 | Sprint | #No of days | Deliverable |
---|---|---|---|
06/25/2020 - 07/09/2020 | DCAE Guilin Sprint 1 (Planning) | 9 | Finalize DCAE scope and committment |
07/10/2020 - 07/23/2020 | DCAE Guilin Sprint 2 | 10 | |
07/24/2020 - 08/06/2020 | DCAE Guilin Sprint 3 | 10 | M2/M3 -
|
08/07/2020 - 08/20/2020 | DCAE Guilin Sprint 4 | 10 | |
08/21/2020 - 09/03/2020 | DCAE Guilin Sprint 5 | 10 | M4 -
|
09/04/2020 - 09/17/2020 | DCAE Guilin Sprint 6 | 9 | |
09/18/2020 - 10/01/2020 | DCAE Guilin Sprint 7 | 10 | RC0 -
|
10/02/2020 -11/05/2020 | Integration support |
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
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.