Introduction

This page discusses the process to install SDNR/

Introduction

This page discusses the process to install SDNR/SDNC into the ONAP installation at OWL (ONAP Open Wireless Laboratory) in WINLAB at Rutgers University.  The ONAP installation itself OWL/WINLAB laboratory environment is described in the wiki page ONAP Open 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.

...

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 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 approach accords with the policy of keeping features in CCSDK and will help us better leverage the work of the OOM group because their Helm charts install SDNC and not CCSDK.  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 SDN-R Developer Guide.  This page begins with the assumption assumes that you have installed your features and included them in the "component meta-feature" for the repository ccsdk/features/sdnr/northbound.

...

<parent>$
    <groupId>org.onap.ccsdk.parent</groupId>$
    <artifactId>single-feature-parent</artifactId>$
    <version>1.1.2-SNAPSHOT<2</version>$
    <relativePath/>$
</parent>$

<parent>$
    <groupId>org.onap.ccsdk.parent</groupId>$
    <artifactId>feature-repo-parent</artifactId>$
    <version>1.1.2-SNAPSHOT<2</version>$
    <relativePath/>$
</parent>$

<parent>$
    <groupId>org.onap.ccsdk.parent</groupId>$
    <artifactId>odlparent-lite</artifactId>$
    <version>1.1.2-SNAPSHOT<2</version>$
    <relativePath/>$
</parent>$

<parent>$
    <groupId>org.onap.ccsdk.parent</groupId>$
    <artifactId>binding-parent</artifactId>$
    <version>1.1.2-SNAPSHOT<2</version>$
    <relativePath/>$
</parent>$

<groupId>org.onap.ccsdk.distribution</groupId>
<artifactId>distribution-odlsli</artifactId>
<version>0.3.2-SNAPSHOT<2</version>
<packaging>pom</packaging>

The Dockerfile in ccsdk/distribution/odlsli/src/main/docker that creates the CCSDK Docker images needs to be updated with the correct tag for the OpenDaylight Oxygen image. 

Change:

# Base ubuntu with added packages needed for open ecomp
FROM onap/ccsdk-odl-oxygen-image:${project.version}

...

Notice that the version number for the Casablanca branch of SDNC is 1.4.2-SNAPSHOT, which differs from the version for CCSDK: 0.3.2-SNAPSHOT.  Also, it specifies a property for the tag of the CCSDK Docker image as "0.3-STAGING-latest."  The file sdnc/oam/installation/sdnc/installation/sdnc/src/main/docker/Dockerfile shows:

# Base ubuntu with added packages needed for open ecomp
FROM onap/ccsdk-odlsli-image:${ccsdk.docker.version}
...

I set Update the name and tag for the CCSDK Docker image in the Dockerfile to the new image that you had just created.

# Base ubuntu with added packages needed for open ecomp
# FROM onap/ccsdk-odlsli-image:${ccsdk.docker.version}
FROM oof-pci/ccsdk-odlsli-image:0.3.2-SNAPSHOT
...

With that single change, one can navigate to sdnc/oam/installation/sdnc and execute the command "mvn clean install -P docker" to create the custom SDNC image.  One now has these images.

...

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 Instead, we use 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  (please contact me for access).  The next step is to push the new image to that Docker hub.  I Below, we first rename the image to something meaningful to the proof-of-concept and then push it.

% docker login --username ft3e0tab7p92qsoceonq<docker-hub-username>
% docker tag onap/sdnc-image:1.4.2-SNAPSHOT ft3e0tab7p92qsoceonq<docker-hub-username>/oof-pci-sdnr:1.4.2-SNAPSHOT
% docker push ft3e0tab7p92qsoceonq<docker-hub-username>/oof-pci-sdnr:1.4.2-SNAPSHOT
The push refers to repository [docker.io/ft3e0tab7p92qsoceonq<docker-hub-username>/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

...

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 parameters 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 (~/oof-pci/override-onap.yaml) 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.

cd ~/git/oom/kubernetes
sudo helm deploy demo ./onap --namespace onap -f ~/oof-pci/override-onap.yaml -f ~/oof-pci/override-sdnc.yaml

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 ~/git/oom/kubernetes/onap/values.yaml and ~/git/oom/kubernetes/sdnc/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.

...

Working with the ONAP oom and integration repositories in the "ubuntu" home directory in sb4-rancher

The sb4-rancher VM is the Rancher controller for the ONAP installation at OWL, and we keep clones of the ONAP oom and integration repositories in the ubuntu home directory.  Below are commands to execute as user ubuntu in a terminal session with sb4-rancher.  Please edit these commands if something is wrong or missing.

After these commands, the repositories and Helm resources have been updated to the latest versions, and we can use the commands described in the next section to deploy our code into ONAP.

Preparing to install the SDNC Docker image

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 parameters 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 (~/oof-pci/override-onap.yaml) 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 ~/oof-pci files are located into https://github.com/onap-oof-pci-poc/ccsdk repository.

cd ~/git/oom/kubernetes
helm install sdnc/ -n demo-sdnc --namespace onap -f ~/oof-pci/override-onap.yaml -f ~/oof-pci/override-sdnc.yaml

The parameter "demo" is used to preface each ONAP component with "demo-" so we have "demo-sdnc," for example.  The "sdnc/" 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 ~/git/oom/kubernetes/onap/values.yaml and ~/git/oom/kubernetes/sdnc/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.  Use these commands.

helm del demo-sdnc --purge
kubectl get persistentvolumeclaims -n onap | grep demo-sdnc | sed -r 's/(^[^ ]+).*/kubectl delete persistentvolumeclaims -n onap \1/' | bash
kubectl get persistentvolumes      -n onap | grep demo-sdnc | sed -r 's/\(^[^ ]\+\).*/kubectl delete secretspersistentvolumes      -n onap \1/' | bash
kubectl get secrets       -n onap \1/' kubectl get clusterrolebindings    -n onap | grep demo-sdnc | sed -r 's/\(^[^ ]\+\).*/kubectl delete clusterrolebindings secrets                -n onap \1/'

...

 | bash
kubectl get clusterrolebindings    -n onap | grep demo-sdnc | sed -r 's/(^[^ ]+).*/kubectl delete clusterrolebindings    -n onap \1/' | bash

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 wiki page.  The "helm del..." command takes some time, so please be patient.  Once discover and delete those resources.  The "helm del..." command takes some time, so be patient.  Once SDNC has been deleted, you can install the new version using the commands in the previous section.

Accessing SDNC/SDNR

SDNC/SDNR Browser Interfaces

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

...

We see that there are three instances of SDNC running and two instances of SDNC-DB and that they are deployed in different nodes, as expected.  All of the pods have private IP addresses that are not accessible from outside the ONAP deployment, but demo-sdnc-sdnc-0 is installed in NODE sb4-k8s-4, which has IP address 10.31.1.79.  We If you cannot use ping to determine the IP address of the node, the command "kubectl describe node <node-name> -n <namespace>" will provide the address.

You can now enter this command.

% kubectl get svc -n onap | grep NAME && kubectl get svc -n onap | grep sdnc
NAME                          TYPE           CLUSTER-IP      EXTERNAL-IP                            PORT(S)                                                       AGE
sdnc                          NodePort       10.43.141.133   <none>                                 8282:30202/TCP,8202:30208/TCP,8280:30246/TCP,8443:30267/TCP   20h
sdnc-ansible-server           ClusterIP      10.43.41.91     <none>                                 8000/TCP                                                      20h
sdnc-cluster                  ClusterIP      None            <none>                                 2550/TCP                                                      20h
sdnc-dbhost                   ClusterIP      None            <none>                                 3306/TCP                                                      20h
sdnc-dbhost-read              ClusterIP      10.43.100.184   <none>                                 3306/TCP                                                      20h
sdnc-dgbuilder                NodePort       10.43.16.12     <none>                                 3000:30203/TCP                                                20h
sdnc-dmaap-listener           ClusterIP      None            <none>                                 <none>                                                        20h
sdnc-portal                   NodePort       10.43.40.149    <none>                                 8843:30201/TCP                                                20h
sdnc-sdnctldb01               ClusterIP      None            <none>                                 3306/TCP                                                      20h
sdnc-sdnctldb02               ClusterIP      None            <none>                                 3306/TCP                                                      20h
sdnc-ueb-listener             ClusterIP      None            <none>                                 <none>                                                        20h
so-sdnc-adapter               ClusterIP      10.43.141.124   <none>                                 8086/TCP                                                      2d

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 (the Dockerfile that creates the SDNC image maps host port 8282 to container port 8181).  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.

Image Added

SDNC/SDNR Terminal Session

There are (at least) two ways to open a terminal session with SDNC/SDNR.  One way is through the command line.  To learn the names of the SDNC/SDNR pods:

% kubectl get NodePortpods -n onap | grep demo-sdnc-sdnc
 10.43.16.12demo-sdnc-sdnc-0      <none>                                 3000:302032/TCP2       Running                 0                        20h
sdnc-dmaap-listener20m
demo-sdnc-sdnc-1           ClusterIP      None            <none>          2/2       Running                <none>                                         0          3m
demo-sdnc-sdnc-2     20h sdnc-portal                   NodePort       10.43.40.149    <none>   2/2       Running                 0      8843:30201/TCP    3m
demo-sdnc-sdnc-ansible-server-7ddf4c54dd-7t5l5         1/1       Running                 0          20h20m
demo-sdnc-sdnctldb01sdnc-db-0               ClusterIP      None            <none>   2/2       Running                 0      3306/TCP    20m
demo-sdnc-sdnc-db-1                                    2/2       Running      20h sdnc-sdnctldb02          0     ClusterIP      None   3m
demo-sdnc-sdnc-dgbuilder-647d9bddb8-t8lsh         <none>     1/1       Running                 0    3306/TCP      20m
demo-sdnc-sdnc-dmaap-listener-f9c9fd74c-vblr7          0/1       Init:0/1                0          20m
demo-sdnc-sdnc-portal-6fcd6b8445-dkxfq   20h sdnc-ueb-listener             ClusterIP1/1      None Running           <none>      0          20m
demo-sdnc-sdnc-ueb-listener-849d6498b5-q2jhf           0/1     <none>  Init:0/1                0          20m

Then, to open a session with demo-sdnc-sdnc-0, for example, enter:

% kubectl exec -it demo-sdnc-sdnc-0 -n onap -- /bin/bash
Defaulting container name to sdnc.
Use 'kubectl describe pod/demo-sdnc-sdnc-0' to see all of the containers in this   20h
so-sdnc-adapter               ClusterIP      10.43.141.124   <none>                                 8086/TCP                          pod.
root@demo-sdnc-sdnc-0:/#

Another approach is to use the Kubernetes GUI.  Browse to the GUI, enter "sdnc" in the "Search" window and then scroll down to "Pods."

Image Added

Click on "demo-sdnc-sdnc-0," for example, and then on "EXEC" in the new window with details about that pod.

Image Added

This will open a new window with a terminal session to the SDNC container in that pod.

Image Added

DMaaP Topics

These DMaaP messages are created and working in OWL.

• DCAE_EVENT_OUTPUT
• PCI-NOTIF-TOPIC-NGHBR-LIST-CHANGE-INFO
• SDNR-CL
• SDNR-CL-RSP

Please let me know if I missed a message.  The URL for the DMaaP message router is http://10.31.1.51:30227 (VM sb4-k8s-3).  The DMaaP message router doesn’t inspect the contents of a message, so the messages are free-form.  Here’s an example of a publish:

POST http://10.31.1.51:30227/events/SDNR-CL
Body
{"name": "value"}

And a subscribe:

GET http://10.31.1.51:30227/events/SDNR-CL/group-id-1/consumer-id-1

You can work from your local machine by setting up a tunnel, e.g.,

ssh -A -t <username>@console.sb10.orbit-lab.org -L 30227:localhost:30227 \
ssh -A -t <username>@node2-1                            2d

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.

...

-L 30227:localhost:30227 \
ssh -A -t <username>@10.31.1.51                 -L 30227:localhost:30227

With that tunnel, you can access the message router at localhost:30227.

Conclusion

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