| Table of Contents |
|---|
This document describes how to develop and general pre-requisites for DCAEGEN2 sub-components; Topics that are generic across ONAP are not covered by this document,
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.
...
- 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.
- 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
- Push seed code (if available) into gerrit
- Reference this ONAP WiKi page for details of configuring for using Gerrit: Configuring Gerrit.
- Build/enhance functional component (mS) based on the usecase requirement
- Setup Jenkins job (under ci-management repo) for building artifacts/docker images.
...
- 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.
- Perform CLM/coverty scan and address all CRITICAL/HIGH License/security issues identified (Required for passing release candidate)
- Define CSIT test (How to guide → Creating a CSIT Test)
- Code Coverage - Min 55% 52% (Required for passing release candidate)
- Logging compliance (https://wiki.onap.org/pages/viewpage.action?pageId=28378955) (Required for passing release candidate)
- If API's are exposed, need to conform to ONAP API Common Versioning Strategy (CVS) Guidelines
...
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.
...
Once the components meet all above criteria, the component will be included in the DCAE bootstrap process to enable deployment during ONAP/DCAE instantiation (this step is optional if component will be deployed through CLAMP).
Artifact Requirements
There are two levels of artifacts that will be built from ONAP source codes:
- Software component
- jar, war, wheel/pypi, wagon, etc.
- Docker container
It is generally expected that each functional entity of DCAE project to be available and packaged into Docker images. Docker versioning guideline can be found at .
CSIT testing
CSIT is an integrated automatic testing practice of ONAP for container level testing. It is expected that component contributors to implement CSIT testing plans for their components so that basic component level integrity can be tested. More information regarding CSIT testing can be found at: Creating a CSIT Test.
Bug reporting
Bugs are tracked using the ONAP JIRA system available under the DCAE project: https://jira.onap.org/secure/RapidBoard.jspa?rapidView=49&view=planning.nodetail
Resources
JJB - https://wiki.onap.org/display/DW/Using+Standard+Jenkins+Job+%28JJB%29+Templates
CSIT - Creating a CSIT Test
Documentation - 2017-09-19 Documentation Tutorial, Further information regarding documentation can also be found here: http://onap.readthedocs.io/en/latest/index.html.
DCAE JIRA - https://jira.onap.org/secure/RapidBoard.jspa?rapidView=49&view=planning.nodetail