Table of Contents |
---|
...
- 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 candidateTSC MUST HAVE)
- Define CSIT test (How to guide → Creating a CSIT Test)
...
- Must support Java11 (or higher) or Python 3.x (as recommended by SECCOM for targetted release) (Required for passing release candidateTSC MUST HAVE)
- Code Coverage - Min 60% (Required for passing release candidateTSC MUST HAVE)
Logging compliance (https://wiki.onap.org/pages/viewpage.action?pageId=28378955)- Log to be written into file and stdout(Required for passing release candidatestdout (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)
Note: All above are general ONAP requirements for any new contributions. TSC MUST HAVE are required for passing release candidate.
Once the service code is delivered and container can be built, follow below DCAE Platform Integration steps
...
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.
...
- Specify ONAP deployment dependencies/pre-requisite and how to validate them (can be explained from links under - DCAE R4 reference : DCAE R6 Service Component (On-demand) deployment Instruction)
- Walkthrough component blueprint/input files and configuration
- Deployment Demo (though Cloudify/cli)
- Deployment Validation (health check/logs)
- Functional Flow simulation (using scripts/curl for mocking up feed)
- Corresponding validation (logs and/or dmaap)
- Common Q&A
- List of Features/JIRA's deferred for next release
- Complaint with ONAP Logging guidelines/CBS integration?
- Can multiple instance be run in-parallel (for scaling)? Any external dependency for persistence?
- Common Q&A
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
...