Introduction
SDN-R is a specialization of the OpenDaylight controller, developed in the OpenDaylight project.
Technical bullets
- OSGi architecture, using the Apache Karaf runtime environment.
- OpenDaylight framework for Service Abstraction (MDSAL), NETCONF, YANG Tools
- Docker/Linux for feature bundling and provisioning
The development of SDN-R bases on ONAP elements CCSDK, SDNC, OOM and ONAP Documentation.
Each of this elements is represented by different gerrit repositories for the path of service delivery:
- CCSDK provides features (=single feature) and feature bundles (= meta feature or microservice)
- SDNC provides an image, prepared to run in the the ONAP service environment
- OOM provides scripts and configurations for deployment in the complex ONAP solution targeting Helm and Kubernetes as platform
- ONAP Documentation is providing user developer documentation, delivered via INTERNET
SDN-R is not listed. This is because it is defined by a specific configuration of the SDNC container, established during provisioning by OOM Scripts.
- SDN-R = SDNC containers + SDN-R configuration
One piece of SDN-R functionality is a microservice. The microservice is running in OSGi (Karaf) context using the Opendaylight platform and provided as a features and OSGi bundles.
Development steps
The general steps to provide this feature are descibed by the list below with examples in the following sections.
The development work is done in four 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 depicted
The steps 1 and 2 of the development and delivery to ONAP project are depicted here:
SDN-R Sandbox
For development purpose and local testing there is a further github repository available that can be used as sandbox with less strict access.
The sdnr sandbox is located here: https://github.com/onap-oof-pci-poc/ccsdk.
- This repository is a merge of the gerrit repositories ccsdk/feature and ccsdk/distribution using the bold marked elements as subdirectories in difference to the ONAP gerrit, but using the same directory structure below.
- There are further ReadTheDocs and OOM/HELM related information available in this repository.
- The github/ccsdk/distributions are designed to allow a simpler setup using docker on a development server.