...

Prerequisites

• kubernetes v1.19 +

  • local kubectl utility

  • a connected kubernetes cluster

  • istio installed on the cluster

• docker and docker-compose (latest)

• git
• Text editor, e.g. vi, notepad, nano, etc.
• helm
• helm3

• bash

• library 'envsubst' must be installed (check installation using command: type envsubst )

• library 'jq' must be installed check installation using command: type jq )

• keytool

• openssl

• ChartMuseum to store the HELM charts on the server, multiple options are available:

  • Execute the install script:
    ./dep/smo-install/scripts/layer-0/0-setup-charts-museum.sh

  • Install chartmuseum manually on port 18080 (https://chartmuseum.com/#Instructions, https://github.com/helm/chartmuseum)

Introduction to Helm Charts

In NONRTRIC we use Helm chart as a packaging manager for kubernetes. Helm charts helps developer to package, configure & deploy the application and services into kubernetes environments.

Before proceeding you will need to be familar with helm, kubernetes and  basic bash. For an introduction to helm see: https://helm.sh/docs/intro/quickstart/

Preparations

Download the the it/dep repository.

git clone "https://gerrit.o-ran-sc.org/r/it/dep"

...

Requirement on Kubernetes

The demo set can be run on local or remote kubernetes cluster. Kubectl must be configured to point to the applicable kubernetes instance. Nodeports exposed by the kubernetes instance must be accessible by the local machine - basically the kubernetes control plane IP needs to be accessible from the local machine. (The installation scripts take care of getting a token form Istio, using dep/ranpm/install/scripts/kube_get_controlplane_host.sh as the baseurl. The K8s controlplane should be accessible from localhost)

• The latest version of istio must be installed on the cluster.

Introduction to Helm Charts

In NONRTRIC we use Helm chart as a packaging manager for kubernetes. Helm charts helps developer to package, configure & deploy the application and services into kubernetes environments.

Before proceeding you will need to be familiar with helm, kubernetes and basic bash scripting. For an introduction to helm see: https://helm.sh/docs/intro/quickstart/

Preparations

Download the the it/dep repository.

#Submodulegit 'ranpm'clone ("https://gerrit.o-ran-sc.org/r/nonrtric/plt/ranpm) registered for path 'ranpm'
#Submodule 'ric-depit/dep"

However, for some use cases below you will also need to clone some additional linked repositories (git submodules). 
To download these, replace the command above to include the '–recursive' parameter/switch:

#Submodule 'ranpm' (https://gerrit.o-ran-sc.org/r/ric-nonrtric/plt/ric-depranpm) registered for path 'ric-depranpm'
#Submodule 'smo-install/multicloud-k8sric-dep' (https://github.com/onap/multicloud-gerrit.o-ran-sc.org/r/ric-plt/ric-dep) registered for path 'ric-dep'
#Submodule 'smo-install/multicloud-k8s' (https://github.com/onap/multicloud-k8s.git) registered for path 'smo-install/multicloud-k8s'
#Submodule 'smo-install/onap_oom' (https://gerrit.onap.org/r/oom) registered for path 'smo-install/onap_oom'
git clone --recursive "https://gerrit.o-ran-sc.org/r/it/dep"

...

The file shown below is a snippet from the override file: example_recipe.yaml.

All parameters beginning with 'install' can be configured 'true' for enabling installation and 'false' for disabling installation.

...

There are many other parameters in the file that may require adaptation to fit a certain environment. For example hostname, namespace and port to kafka message router etc. These integration details are not covered in this guide.  

# Here you can enable inclusion or exclusion of each component. A not enabled componentDisabled components will not be installed., nonrtric:and their later installPms:configurations true
  will be ignored.
nonrtric:
  installPms: true
  installA1controller: true
  installA1simulator: true
  installControlpanel: true
  installInformationservice: true
  installRappcatalogueservice: true
  installRappcatalogueenhancedservice: true
  # Enable either installNonrtricgateway or installKong. Both cannot be enabled at the same time
  installNonrtricgateway: false
  installKong: true 
  installDmaapadapterservice: true
  installDmaapmediatorservice: true
  installHelmmanager: true
  installOrufhrecovery: true
  installRansliceassurance: true
  installCapifcore: true
  installServicemanager: true
  # When enabling Ranpm, set value false above for installControlpanel, installInformationservice, installNonrtricgateway
  installRanpm: false
  # rApp Manager functionality relies on ONAP ACM for its operation
  installrAppmanager: true
  # DME Participant should only be activated when ONAP ACM installation is available for this participant to utilize
  installDmeParticipant: false

  volume1:
    # Set the size to 0 if you do not need the volume (if you are using Dynamic Volume Provisioning)
    size: 2Gi
    storageClassName: pms-storage
    hostPath: /var/nonrtric/pms-storage
  volume2:
     # Set the size to 0 if you do not need the volume (if you are using Dynamic Volume Provisioning)
    size: 2Gi
    storageClassName: ics-storage
    hostPath: /var/nonrtric/ics-storage
  volume3:
    size: 1Gi
    storageClassName: helmmanager-storage

...
...
...

...

...

sudo ./bin/deploy-nonrtric.sh -f dep/nonrtric/RECIPE_EXAMPLE/example_recipe.yaml

Additional instructions for RANPM Installation

Prerequisites

The ranpm setup works on linux/MacOS or on windows via WSL using a local or remote kubernetes cluster.
Required:

• local kubectl utility
• a connected kubernetes cluster
• a local version of docker for building images

It is recommended to run the ranpm on a kubernetes cluster instead of local docker-desktop etc. as the deployment is somewhat resource intensive.

Requirement on Kubernetes

The demo set can be run on local or remote kubernetes cluster. Kubectl must be configured to point to the applicable kubernetes instance. Nodeports exposed by the kubernetes instance must be accessible by the local machine - basically the kubernetes control plane IP needs to be accessible from the local machine. (The installation scripts take care of getting a token form Istio, using dep/ranpm/install/scripts/kube_get_controlplane_host.sh as the baseurl. The K8s controlplane should be accessible from localhost)

• The latest version of istio must be installed on the cluster.

Other requirements

• helm3
• bash
• library 'envsubst' must be installed (check installation using command: type envsubst )
• library 'jq' must be installed check installation using command: type jq )
• keytool
• openssl

Before installation

The following images need to be built manually. If remote or multi node cluster is used, then an image repo needs to be available to push the built images to. If external repo is used, use the same repo for all built images, and configure the reponame in helm/global-values.yaml

The parameter value of extimagerepo shall have a trailing '/' at the end.

Build the following images (Build instruction in each directory)

• https-server
• pm-rapp

Installation (RANPM Only)

The installation is made by a few scripts. The main part of the ranpm is installed by a single script. Then, additional parts can be added on top. All installations in kubernetes is made by helm charts.

The following scripts are provided for installing (install-nrt.sh must be executed first):

The kubeconfig file of the local cluster should be aligned to the cluster's control plane node's internal IP

• install-nrt.sh : Installs the main parts of the ranpm setup
• install-pm-log.sh : Installs the producer for influx db
• install-pm-influx-job.sh : Sets up an alternative job to produce data stored in influx db.
• install-pm-rapp.sh : Installs a skeleton rApp-placeholder that subscribes and print out received data

>sudo kubectl get po -n nonrtric

            NAME                                                 READY     STATUS     RESTARTS            AGE  
bundle-server-7f5c4965c7-vsgn7                                    1/1     Running        0               8m16s
dfc-0                                                             2/2     Running        0               6m31s
influxdb2-0                                                       1/1     Running        0               8m15s
informationservice-776f789967-dxqrj                               1/1     Running        0               6m32s
kafka-1-entity-operator-fcb6f94dc-fkx8z                           3/3     Running        0               7m17s
kafka-1-kafka-0                                                   1/1     Running        0               7m43s
kafka-1-zookeeper-0                                               1/1     Running        0               8m7s
kafka-client                                                      1/1     Running        0               10m
kafka-producer-pm-json2influx-0                                   1/1     Running        0               6m32s
kafka-producer-pm-json2kafka-0                                    1/1     Running        0               6m32s
kafka-producer-pm-xml2json-0                                      1/1     Running        0               6m32s
keycloak-597d95bbc5-nsqww                                         1/1     Running        0               10m
keycloak-proxy-57f6c97984-hl2b6                                   1/1     Running        0               10m
message-router-7d977b5554-8tp5k                                   1/1     Running        0               8m15s
minio-0                                                           1/1     Running        0               8m15s
minio-client                                                      1/1     Running        0               8m16s
opa-ics-54fdf87d89-jt5rs                                          1/1     Running        0               6m32s
opa-kafka-6665d545c5-ct7dx                                        1/1     Running        0               8m16s
opa-minio-5d6f5d89dc-xls9s                                        1/1     Running        0               8m16s
pm-producer-json2kafka-0                                          2/2     Running        0               6m32s
pm-rapp                                                           1/1     Running        0               67s
pmlog-0                                                           2/2     Running        0               82s
redpanda-console-b85489cc9-nqqpm                                  1/1     Running        0               8m15s
strimzi-cluster-operator-57c7999494-kvk69                         1/1     Running        0               8m53s
ves-collector-bd756b64c-wz28h                                     1/1     Running        0               8m16s
zoo-entrance-85878c564d-59gp2                                     1/1     Running        0               8m16s

>sudo kubectl get po -n ran

 NAME              READY     STATUS   RESTARTS      AGE
pm-https-server-0   1/1     Running      0          32m
pm-https-server-1   1/1     Running      0          32m
pm-https-server-2   1/1     Running      0          32m
pm-https-server-3   1/1     Running      0          32m
pm-https-server-4   1/1     Running      0          31m
pm-https-server-5   1/1     Running      0          31m
pm-https-server-6   1/1     Running      0          31m
pm-https-server-7   1/1     Running      0          31m
pm-https-server-8   1/1     Running      0          31m
pm-https-server-9   1/1     Running      0          31m

Uninstalling (RANPM Only)

There is a corresponding uninstall script for each install script. However, it is enough to just run uninstall-nrt.sh and uninstall-pm-rapp.sh.

Exposed ports to APIs

All exposed APIs on individual port numbers (nodeports) on the address of the kubernetes control plane.

Keycloak API

Keycloak API accessed via proxy (proxy is needed to make keycloak issue token with the internal address of keycloak).

• nodeport: 31784

OPA rules bundle server

Server for posting updated OPA rules.

• nodeport: 32201

Information coordinator Service

Direct access to ICS API.

• nodeports (http and https): 31823, 31824

Ves-Collector

Direct access to the Ves-Collector

• nodeports (http and https): 31760, 31761

Exposed ports to admin tools

As part of the ranpm installation, a number of admin tools are installed. The tools are accessed via a browser on individual port numbers (nodeports) on the address of the kubernetes control plane.

Keycloak admin console

Admin tool for keycloak.

• nodeport : 31788
• user: admin
• password: admin

Redpanda consule

With this tool the topics, consumer etc can be viewed.

• nodeport: 31767

Minio web

Browser for minio file-store.

• nodeport: 31768
• user: admin
• password: adminadmin

Influx db

Browser for influx db.

• nodeport: 31812
• user: admin
• password: mySuP3rS3cr3tT0keN

Result of the installation

The installation will create one helm release and all created kubernetes objects will be put in namespace 'nonrtric' (cannot be changed).

Once the installation is done you can check the created kubernetes objects by using command kubectl.
Example : Deployed pods when all components are enabled:

sudo ./bin/deploy-nonrtric.sh -f dep/nonrtric/RECIPE_EXAMPLE/example_recipe.yaml

Installing / Uninstalling the RAN PM functions

See the sub-page Release J - Run in Kubernetes - Additional instructions for RANPM Installation for more details.

Uninstalling

There is a script that uninstalls installs the NONRTRIC components. It is simply run like this:

sudo ./dep/bin/undeploy-nonrtric.sh

...