Development steps for code
The general steps to provide a feature is descibed by the list below with examples in the following sections.
Example project name is "MyNewService".
The development work is done in ONAP gerrit repositories, following the ONAP prozesses and rules:
- gerrit-repo:ccsdk/features → Provide here the features as single ZIP Installer for all bundles
- Bundles with service functionality as ZIP archive containing a maven repository that is later added/installed into the Opendaylight/karaf repository
- Provide feature xml that can be added to Opendaylight/karaf to manage the installation
- gerrit-repo: sdnc/oam → Add for creation of SDNC image the feature to repository and provide installer to /installer/sdnc
- Add dependency to pom.xml to move it into container's ODL repository. $ODL_HOME/system/org/onap/ccsdk/features/sdnr/...
- Add myNewService repository to ODL startup configuration that it is available to be activated.
File to change: $ODL_HOME/etc/org.apache.karaf.features.cfg feature repository list, specified by featuresRepositories=- "sdnc/oam":"/installation/sdnc/src/main/docker/Dockerfile"
- "sdnc/oam":"/installation/sdnc/src/main/docker/standalone.Dockerfile"
- Add to startODL.sh functionality to startup service if configured to be active. Use environment variable like "SDNR_MyNewService" true|false. (Be aware .. this script is normally overwritten by oom .. see next step)
- gerrit-repo: oom → Add functionality to configure and start your service
- Add to startODL.sh the functionality to startup service if configured to be active.
- Extend script to set related ENV variables with configuration of specific feature bundel.
Development steps for Documentation
The documentation structure has a own setup.
Goal is to have the user and developer documentation in one common service. ONAP name is "ReadTheDocs".