Introduction

This page discusses the process to install SDNR/SDNC into the ONAP installation at OWL (ONAP Wireless Laboratory) in WINLAB at Rutgers University.  The ONAP installation itself is described in the wiki page ONAP Wireless Laboratory (OWL) at Wireless Information Network Laboratory (WINLAB).  This page describes how to install a development Docker image of SDNC into ONAP rather than the default image taken from the nexus3.onap.org:10001 repository.

Procedure

Given the close deadline for the proof-of-concept, we have decided to develop our code in a github site that is outside of the ONAP gerrit (there is a description at this wiki page).  The starting point for the code will be a branch of the ONAP gerrit, and we will fully conform with ONAP practices with the intention of submitting the code to the ONAP gerrit after the proof-of-concept.  The OOM Rancher/Kubernetes helm charts are structured to install SDNC, and we have agreed to install the karaf features into CCSDK and then create a SDNC docker image from that CCSDK image.  This is in accord with the policy of keeping features in CCSDK and will help us better leverage the work of the OOM group.  We have also agreed to use the Casablanca branch of both CCSDK and SDNC rather than the master branch because the master branch has been updated to evolve into Dublin and Casablaca will be a stable environment as we work on the proof-of-concept.

We have described the procedure to install a new karaf feature into CCSDK in a set of wiki pages at SDNR SDN-R Developer Guide.  This page begins with the assumption that you have installed your features and included them in the "component meta-feature" for the repository ccsdk/features/sdnr/northbound.

Create a custom CCSDK Docker image

The first step is to create a CCSDK docker image with the desired features.  The procedure to do this is the same as that described at SDNR SDN-R Developer Guide except we are using the Casablanca branch, which requires two principal changes:

...

To minimize confusion, I chose to rename the image to something meaningful for the proof-of-concept: oof-pci/ccsdk-odlsli-image:0.3.2-SNAPSHOT.

Create a custom SDNC Docker image

The next step is to create a custom SDNC Docker image from the newly created CCSDK image.  Navigate to sdnc/oam/installation/sdnc and inspect two files:

...

% docker images
REPOSITORY                                                     TAG                                       IMAGE ID            CREATED             SIZE
onap/sdnc-image                                                1.4-STAGING-latest                        4bb8c2f04a35        12 seconds ago      1.85GB
onap/sdnc-image                                                1.4.2-SNAPSHOT                            4bb8c2f04a35        12 seconds ago      1.85GB
onap/sdnc-image                                                1.4.2-SNAPSHOT-STAGING-20181108T173140Z   4bb8c2f04a35        12 seconds ago      1.85GB
onap/sdnc-image                                                latest                                    4bb8c2f04a35        12 seconds ago      1.85GB
onap/ccsdk-odlsli-image                                        0.3-STAGING-latest                        dc4309c12ee4        27 minutes ago      1.81GB
onap/ccsdk-odlsli-image                                        0.3.2-SNAPSHOT                            dc4309c12ee4        27 minutes ago      1.81GB
onap/ccsdk-odlsli-image                                        0.3.2-SNAPSHOT-STAGING-20181108T170427Z   dc4309c12ee4        27 minutes ago      1.81GB
onap/ccsdk-odlsli-image                                        latest                                    dc4309c12ee4        27 minutes ago      1.81GB
oof-pci/ccsdk-odlsli-image                                     0.3.2-SNAPSHOT                            dc4309c12ee4        27 minutes ago      1.81GB
nexus3.onap.org:10001/onap/ccsdk-odl-oxygen-image              0.3.2-STAGING                             ebc754e1a8b0        37 hours ago        1.69GB
onap/ccsdk-odl-oxygen-image                                    0.3.2-STAGING                             ebc754e1a8b0        37 hours ago        1.69GB
...

Upload the development SDNC Docker image to Docker hub

We now have a development SDNC Docker image, and we want to install it into ONAP at OWL.  We are using the OOM Rancher/Kubernetes approach to installing ONAP, and their scripts pull all of the Docker images from the nexus3.onap.org repository.  To pull down our development image, we must first push it to a Docker repository, but we cannot push it to nexus3 because of access restrictions.  I am using a separate repository in an account in the public Docker hub repository, and I can provide access to others.  We can modify this if it makes sense.  So, the next step is to push the new image to that Docker hub.  I first rename the image to something meaningful to the proof-of-concept and then push it.

% docker login --username ft3e0tab7p92qsoceonq
% docker tag onap/sdnc-image:1.4.2-SNAPSHOT ft3e0tab7p92qsoceonq/oof-pci-sdnr:1.4.2-SNAPSHOT
% docker push ft3e0tab7p92qsoceonq/oof-pci-sdnr:1.4.2-SNAPSHOT
The push refers to repository [docker.io/ft3e0tab7p92qsoceonq/oof-pci-sdnr]
03e7ad007451: Pushed
a0a1cf35dfbe: Pushed
a07a5ef548f3: Pushed
00f72359482f: Pushed
e8bd422087d4: Pushed
e2049f74dbc7: Pushed
a6be3b814740: Pushed
2aee35f4b0cf: Pushed
cdfcf3c88e0c: Pushed
079c4c5e0c3b: Pushed
c4645863df89: Pushed
c931e6de9fae: Pushed
dda32bf9f38e: Pushed
a9d2e609edd2: Pushed
7f1e7f156f10: Pushed
fd502652d1b6: Pushed
1be2b014d5b5: Pushed
95002f737271: Pushed
daf5c98fd708: Pushed
6ddb554c87b4: Pushed
095019da6309: Pushed
6aaca5663342: Pushed
493565e7bfc4: Pushed
a211906d4a22: Pushed
5d3087e4738c: Pushed
2940f1099458: Pushed
f17a07942400: Pushed
93c6b053ea3a: Layer already exists
ba2b9e9c0ba4: Layer already exists
2ee1b8bcd8b9: Layer already exists
8814cf621812: Layer already exists
f332a5c37505: Layer already exists
f1dfa8049aa6: Layer already exists
79109c0f8a0b: Layer already exists
33db8ccd260b: Layer already exists
b8c891f0ffec: Layer already exists
1.4.2-SNAPSHOT: digest: sha256:381f062e441ae3ea32413f002a6cac83161d8280edcee1b85c5257889a024420 size: 7848

Installing the development SDNC Docker image into ONAP

The instructions to create an ONAP installation using the OOM Rancher/Kubernetes approach are in the ONAP wiki site (be sure to select the Casablanca version of the instructions).  Once installed, there are further instructions on deploying ONAP at this wiki page.  To install the development image rather than the nexus3 image, open a terminal session with the VM containing the Rancher controller (sb4-rancher).  There are instructions on how to create a ssh tunnel to sb4-rancher at this wiki page.  Once logged in, we must update parameter in the values.yaml file in the Helm chart for SDNC in the OOM repository, shown here.

% ls -F git/oom/kubernetes/sdnc
charts/  Chart.yaml  Makefile  requirements.lock  requirements.yaml  resources/  sdnc-prom/  templates/  values.yaml

Override file for the SDNC values.yaml file

The simplest way to override the values is to copy the entire values.yaml file into a separate file (I use ~/oof-pci/override-sndc.yaml) and modify the relevant parameters in that new file.  The new values are shown below.  We identify the repository with the source image name and tag, create a cluster of three ODL members, and create a redundant MySQL deployment of two instances.

...

#################################################################
# Application configuration defaults.
#################################################################
# application images
repository: nexus3.onap.org:10001
repositoryOverride: registry.hub.docker.com
pullPolicy: Always
#image: onap/sdnc-image:1.4.1
image: ft3e0tab7p92qsoceonq/oof-pci-sdnr:1.4.2-SNAPSHOT

...

mysql:
  nameOverride: sdnc-db
  service:
    name: sdnc-dbhost
    internalPort: 3306
  nfsprovisionerPrefix: sdnc
  sdnctlPrefix: sdnc
  persistence:
    mountSubPath: sdnc/mysql
    enabled: true
  disableNfsProvisioner: true
  replicaCount: 2
  geoEnabled: false

...

# default number of instances
replicaCount: 3

...

Override file for the ONAP values.yaml file

By default, the OOM Rancher/Kubernetes script installs all of the components, which we do not need for the proof-of-concept.  We identify which components to install by copying the ~/git/oom/kubernetes/onap/values.yaml file into a separate "override" file and changing "enabled: true" to "enabled: false" for the unneeded components.  Currently, these are the selected components.

Command to install ONAP with the development image

Following the guidelines at the OOM wiki page, I use this command to install ONAP with the desired configuration.

...

The parameter "demo" is used to preface each ONAP component with "demo-" so we have "demo-sdnc," for example.  The "./onap" parameter instructs helm to use that directory to guide the deployment.  The "–namespace onap" parameter causes ONAP to be deployed into the kubernetes namespace "onap."  The "-f ~/oof-pci/override-onap.yaml -f ~/oof-pci/override-sdnc.yaml" parameters instruct helm to override the parameters in the ~/git/oom/kubernetes/onap/values.yaml file with the values in the files following the "-f" option.  There can be a series of override files, and the last file takes precedence.

Commands to update the development image

If there is already an instance SDNC installed, it must be deleted before installing a new version.  I use these commands.

...

The first command deletes SDNC but, despite the "–purge" option, some residual resources remain.  The subsequent commands discovers those resources and generates commands that can be copied and pasted into your terminal session to be executed.  If you know how to pipe a string into bash so it can be executed directly, kindly update this code.  The "helm del..." command takes some time, so please be patient.  Once SDNC has been deleted, you can install the new version using the commands in the previous section.

Accessing SDNC/SDNR

Now that SDNC/SDNR is deployed, how can you access it?  I use this sequence of commands.  First:

...

SDNC is presenting a service at a NodePort that is accessible from outside the ONAP installation.  PORT 8282:30202 means that port 30202 is accessible externally and maps to internal port 8282 (I'm not sure why 8282 rather than 8181; a port mapping from 8282 to 8181 may be set in a Dockerfile).  Therefore, SDNC is listening at sb4-k8s-4:30202, or 10.31.1.79:30202.  By creating a ssh tunnel to sb4-k8s-4 (described here), one can open a browser to localhost:30202/apidoc/explorer/index.html and see this.

Conclusion

Please feel free to edit this page to make corrections or improvements.  Your assistance will be greatly appreciated.