Versions Compared

Old Version 1

changes.mady.by.user Herbert Eiselt

Saved on

compared with

New Version Current

changes.mady.by.user Herbert Eiselt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

If an SDN-R feauture or service is provided the following steps have to be covered in the related ONAP gerrit repos

...

  • Add sdnr related feature
  • Use parent-version and artifact-version from parent pom in repo-root

...

  • Add dependencies to pom.xml (for feature-zip and feature xml )
  • Add related repository into Dockerfile

...

  • Add environment variable to enable the feature
  • Add function to add feature name to "bootfeatures" if feature enabled

...

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

gerrit-repo:ccsdk/features → Provide here the features as single ZIP Installer for all bundles

  1. Bundles with service functionality as ZIP archive containing a maven repository that is later added/installed into the Opendaylight/karaf repository
  2. Provide feature xml that can be added to Opendaylight/karaf to manage the installation

gerrit-repo: sdnc/oam

gerrit-repo: sdnc/oam → Add for creation of SDNC image the feature to repository and provide installer to /installer/sdnc

  1. Add dependency to pom.xml to move it into container's ODL repository. $ODL_HOME/system/org/onap/ccsdk/features/sdnr/...

  2. 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=
    1. "sdnc/oam":"/installation/sdnc/src/main/docker/Dockerfile"
    2. "sdnc/oam":"/installation/sdnc/src/main/docker/standalone.Dockerfile"
  3. 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.

Path: /kubernetes/sdnc

Extend script to set related ENV variables with configuration of specific feature bundel.

Path:  /kubernetes/sdnc/resources/config/bin

Add to startODL.sh the functionality to startup service if configured to be active.

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".