Page Comparison

Table of Contents

DCAE platform is microservice centric, the services (collectors and analytics interfacing with NF events) themselves can be build independently and integrated with DCAE with minimal work. However as ONAP itself requiring carrier grade level, all components has strict S3P goals and LF process to comply.

...

Setup required Jenkins job (under ci-management repo) for building artifacts/docker images, sonar-scans, CLM. As a DCAE contributor, to create new Jenkins job will require a new JJB file being created under the jjb/dcaegen2 directory of the ci-managerment project. The status of Jenkins jobs can be viewed at http://jenkins.onap.org.
Push (seed) code into gerrit on the chosen repo (Reference this ONAP WiKi page for details of configuring for using Gerrit: Configuring Gerrit)
1. Ensure complaince with all NFR's (Non-Functionrequirement)
2. Leverage DCAE common sdk for config retrieval/dmaap pub & sub etc (DCAESDKIntegration)
3. License text included in each file. Apache 2 for coding files; CC4 for others.
Ensure all committers and usecase owners/leads are looped into gerrit submission for review
Once change is merged, review CLM/coverty scan report and address all CRITICAL/HIGH License/security issues identified (TSC MUST HAVE)
1. Reports will be under https://nexus-iq.wl.linuxfoundation.org/assets/index.html (access is restricted; work with committers to obtain the report)
ONAP deployment integration (see section below)
DCAE MOD integration support
1. Every component to be onboarded into DCAE, should prepare a component spec (a.k.a spec) - which is meta data represented in json describing the component configuration model. Details on spec creation and validation can be found under ONAP.readthedocs (corresponding source in gerrit). The spec file should be added into component repo (under <repo><component>/dpo/spec directory). For more info on component spec, refer https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/design-components/component-specification/index-component-specification.html
Add CSIT test (How to guide → Creating a CSIT Test). This can be done under "integration" repo or within component repo itself (see dcaegen2/services/pm-mapper or dcaegen2/collectors/datafile)
Documentation
Demo

Non-

...

Functional requirement

All new contribution MUST be complaint with Global requirements and approved "best Practice" requirements. Following list key NFR's

Support Java11 (or higher) or Python 3.x (as recommended by SECCOM for targetted release) (TSC MUST HAVE)
Code Coverage - Min 8080% (TSC DCAE MUST HAVE)
Logging compliance to Best Practice requirement - Jakarta Best Practice Proposal for Standardized Logging Fields (old spec - ~~https://wiki.onap.org/pages/viewpage.action?pageId=28378955)~~
Log to be written into file and stdout (TSC MUST HAVE)

- If API's are exposed, need to conform to ONAP API Common Versioning Strategy (CVS) Guidelines
- Containers must have no more than one main process (TSC MUST HAVE)
- Containers must crash properly when a failure occurs (TSC MUST HAVE)
- No hardcoded password in the container (should be made configurable and set at deployment time and sourced using CBS apis') (TSC MUST HAVE)
- Use ONAP-integration supported base image

Note: All above are common ONAP requirements for any new contributions. TSC MUST HAVE are required for passing release candidate.

...

New DCAE Microservice chart contribution should go under https://git.onap.org/oom/tree/kubernetes/dcaegen2-services; all DCAE component charts should leverage oom/kubernetes/dcaegen2-services/common/dcaegen2-services-common templates. Refer to following link - https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/dcaeservice_helm_template.html for details on the supported features via this template.

DCAE SDK Integration

With Jakarta release, Consul and ConfigBindingService interface has been deprecated from DCAE. All Microservice configuration are resolved through files mounted via Configmap created part of dcae-services helm chart deployment. CBS SDK library are available within DCAE which can be used by DCAE Microservices for configuration retrieval. For details on the API - refer CBS SDK Java Library .

...

The project wiki space (https://wiki.onap.org/display/DW/DCAE+Documentation) can be used to documents general design about the components itself; can serve the community to know about the component itself and point to other repo/release documentation.

...