| Table of Contents |
|---|
DCAE platform being is microservice centric, the services 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.
For community members looking to contribute new service under ONAP DCAE project, below general pre-requisites should be metsteps outline general steps to be followed by the service owners.
- 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).
- 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
- Push seed Code into gerrit (if available)
- Build/enhance functional component (mS)
- Setup Jenkins job (under ci-management repo) for building artifacts/docker images.
- Perform CLM/coverty scan and address all CRITICAL/HIGH License/security issues identified (Required for passing release candidate)
- Defined Define CSIT test (How to guide → Creating a CSIT Test)
- Code Coverage of 50% or more (Required for passing release candidate)
- S3P (all scaling/resiliency/security/maintainability) goals should meet at the minimum level defined for DCAE project for the targeted release (Required for passing release candidate)
Note: Components should support secure topic pub/sub for DMAAP - Logging compliance (https://wiki.onap.org/pages/viewpage.action?pageId=28378955) (Required for passing release candidate)Documentation to be provided (on components configuration, deployment steps and dependencies and overall design)
Note: All above are general ONAP requirements for any new contributions.
Once the service code is delivered and container can be built, follow below DCAE Platform Integration steps
- DCAE Platform Integration
- Documentation
- Demo
- Deployment integration.
DCAE Platform Integration
Once the main functionality is build and components is executable as docker container/jar - it should be integrated with DCAE platform to enable dynamic instantiation and configuration management by DCAE controller.
Build component spec and validate using dcae_cli (Design support)
...
If the component is stateful, it should persist its state on external store (eg. pg, redis) to allow support for scaling and resiliency. This should be important design criteria for the component. If the component fails to meet S3P goals, it will not be release candidate.
Documentation
DCAE WIKI
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.
README file
Each of service component repository must include a README instruction on how the repo should cloned, build locally and executed.
Release documentation
All DCAE components release specific documentation are maintained as source under https://gerrit.onap.org/r/gitweb?p=dcaegen2.git;a=tree;f=docs;h=e9ccbe4509762968a5028afb8dc55be3236beb6d;hb=refs/heads/master repository. This repo has documentation build setup and generated RTD can be found here - https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/index.html
Service component related RST can be added under separate directory created here - https://gerrit.onap.org/r/gitweb?p=dcaegen2.git;a=tree;f=docs/sections/services;h=06c74325e0a604772363faf2a7faecaf94a839ee;hb=refs/heads/master. Post merge/build - corresponding RTD will be located here - https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/services/serviceindex.html
See Resource at the bottom for more information on RTD.
Demo
To be able to certify the component for release, the MS owner should present demo to project team (and integration team) using onap Jenkins build images/container and manual deployment via blueprint under DCAE platform. This demo should be ideally completed before M4 deadline to meet release timeline.
Deployment Integration
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).
...
Resources
JJB - https://wiki.onap.org/display/DW/Using+Standard+Jenkins+Job+%28JJB%29+Templates
CSIT - Creating a CSIT Test
...