...
- Review new service proposal with architecture team and project team. If new collectors, this typically requires review with ARC and VNFREQ team as this introduces new interface between xNF and DCAE.
- Identify usecase this service will be targeted under (optional).
- Capture external and internal dependencies and api consumed/provided .(this could be documented in wiki to start, but swagger spec required by M2)
- Repository creation (PTL will submit request to RM, who will coordinate with TSC/LF support)
- Work with PTL to scope the service and EPIC/US creations and release/sprints to target around M1
...
- 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)
- Ensure complaince with all NFR's (Non-Functionrequirement)
- Leverage DCAE common sdk for config retrieval/dmaap pub & sub etc (DCAESDKIntegration)
- 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)
- 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
- DCAE MOD integration support support (OPTIONAL from KOHN)
- 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. The spec file should be added into component repo (under <repo><component>/dpo/spec directory). For more info on component spec, refer documentation under RTD
- 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
...
- Support Java11 (or higher) or Python 3.x (as recommended by SECCOM for targetted release) (TSC MUST HAVE)
- Code Coverage - Min 80% (DCAE MUST HAVE)
- Logging compliance to Best Practice requirement - Jakarta Best Practice Proposal for Standardized Logging Fields - v2 (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 & OpenAPI spec/swagger file to be defined and shared with impacted project by M2.
- 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
...
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.
With Kohn release, all DCAE components will be enabled for daily/weekly deployments. This is controlled by override here - https://git.onap.org/oom/tree/kubernetes/onap/resources/overrides/onap-all.yaml. New components being added under ONAP, should update this yaml for enabling automated daily/weekly deployment.
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 .
...