In the IT/Dep repo, there are helm charts for each these components. In addition, there is a chart called nonrtric, which is a composition of the components above.

Prerequisites

kubernetes v1.19 +
- local kubectl utility
- a connected kubernetes cluster
- istio installed on the cluster for RANPM
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
- Or Install chartmuseum manually on port 18080 (https://chartmuseum.com/#Instructions, https://github.com/helm/chartmuseum)

Preparations

Download the the it/dep repository. Assuming the contents to be pulled from J-release branch. If needed, may switch to master branch.

Code Block

language	bash
title	Clone repo

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

To download all the submodules add '--recursive':

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

Code Block

language	bash
title	Clone repo

Info

These instructions work on linux/MacOS or on windows via WSL using a local or remote kubernetes cluster.

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

Requirement on Kubernetes (RANPM Installation)

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.

Code Block

language	bash
title	Clone repo

git clone "https://gerrit.o-ran-sc.org/r/ric-pltit/ric-dep) registered for path 'ric-dep'
#Submodule 'smo-install/multicloud-k8sdep"

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:

Code Block

language	bash
title	Clone repo & submodules

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

Configuration of components to install

It is possible to configure which of nonrtric components to install, including the controller and a1 simulators. This configuration is made in the override for the helm package. Edit the following file

Code Block

language	bash
title	Edit override file

<editor> dep/RECIPE_EXAMPLE/NONRTRIC/example_recipe.yaml

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

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

For the parameters installNonrtricgateway and installKong, only one can be enabled.

...

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"

Note: This places all artifacts in a directory 'dep', which is the base directory for all operations that follow.
Note: Git Branches are currently not used in the it/dep repository. The latest version (master branch) is used here, but if changes are made then the instruction below may become outdated. The instructions below are accurate at time of writing, during the J-Release time-frame. Earlier versions of the it/dep repo may be used by examining the Git log for the repo.

Configuration of components to install

It is possible to configure which of nonrtric components to install, including the platform functions, simulators and graphical control panels. This configuration is made in the override for the helm package.
Edit the file dep/RECIPE_EXAMPLE/NONRTRIC/example_recipe.yaml

Code Block

language	bash
title	Edit the override file

# Here you can enable inclusion or exclusion of each component. A not enabled component will not be installed.
nonrtric:
  installPms: true
  installA1controller: true
  installA1simulator: true
  installControlpanel: true
  installInformationservice: true
  installRappcatalogueservice: true
  installRappcatalogueenhancedservice: true
  installNonrtricgateway<editor> ./dep/RECIPE_EXAMPLE/NONRTRIC/example_recipe.yaml

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.

For the parameters installNonrtricgateway and installKong, only one can be enabled.

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.

Code Block

language	bash
title	Edit the override file

# Here you can enable inclusion or exclusion of each component. Disabled components will not be installed, and their later configurations will be ignored.
nonrtric:
  installPms: true
  installKonginstallA1controller: true
  installDmaapadapterserviceinstallA1simulator: true
  installDmaapmediatorserviceinstallControlpanel: true
  installHelmmanagerinstallInformationservice: true
  installOrufhrecoveryinstallRappcatalogueservice: true
  installRansliceassuranceinstallRappcatalogueenhancedservice: true
  installCapifcore:# trueEnable either installNonrtricgateway installServicemanager:or trueinstallKong. Both cannot #be Whenenabled enablingat Ranpmthe switchsame totime
false installControlpanel, installInformationservice, installNonrtricgateway
  installRanpm: false
  #installKong: true rApp
Manager functionality reliesinstallDmaapadapterservice: ontrue
ACM for itsinstallDmaapmediatorservice: operationtrue
  installrAppmanagerinstallHelmmanager: true
  #installOrufhrecovery: DMEtrue
Participant should onlyinstallRansliceassurance: betrue
activated when ACMinstallCapifcore: installationtrue
is available forinstallServicemanager: thistrue
participant to utilize# When enabling installDmeParticipant:Ranpm, falseset value false above volume1:for installControlpanel, installInformationservice, installNonrtricgateway
 # SetinstallRanpm: thefalse
size to 0# ifrApp youManager dofunctionality notrelies needon theONAP volumeACM (iffor youits areoperation
using Dynamic VolumeinstallrAppmanager: Provisioning)true
  # DME size:Participant 2Gishould only be activated when storageClassName: pms-storage
    hostPath: /var/nonrtric/pms-storage
  volume2:
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: icspms-storage
    hostPath: /var/nonrtric/icspms-storage
  volume3volume2:
     # Set the size: to 1Gi0 if you do  storageClassName: helmmanager-storage

...
...
...

Note
When enabling Ranpm switch to false installControlpanel, installInformationservice, installNonrtricgateway. Because these services are getting installed by RANPM helm charts as well with a different Release Name.

...

There is a script that packs and installs the components by using the helm command. The installation uses a values override file like the one shown above. This example can be run like this:

Code Block

language	bash
title	Deploy TEIV

sudo ./install-teiv.sh

RANPM ONLY Installation

Prerequisites

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

local kubectl
kubernetes cluster
local docker for building images

It is recommended to run the ranpm on a kubernetes cluster instead of local docker-desktop etc as the setup requires a fair amount of computer resources.

Requirement on Kubernetes

The demo set can be run on local or remote kubernetes. 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 controlplane should be accessible from localhost)

Latest version of istio installed

Other requirements

helm3
bash
cmd 'envsubst' must be installed (check by cmd: 'type envsubst' )
cmd 'jq' must be installed (check by cmd: '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 /.

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 mush be installed 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 rapp that subscribe and print out received data

Code Block

language	bash
theme	Midnight
title	Get Pods

>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

Code Block

language	bash
theme	Midnight
title	Get Pods

>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

Unstallation(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 (nodeporta) 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.

Keycload 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 filestore.

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 a namespace. This name is 'nonrtric' and 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:

Code Block

language	bash
theme	Midnight
title	Get Pods

>sudo kubectl get po -A

NAME                                            READY   STATUS    RESTARTS      AGE
a1-sim-osc-0                                    1/1     Running   0             2m27s
a1-sim-osc-1                                    1/1     Running   0             117s
a1-sim-std-0                                    1/1     Running   0             2m27s
a1-sim-std-1                                    1/1     Running   0             117s
a1-sim-std2-0                                   1/1     Running   0             2m27s
a1-sim-std2-1                                   1/1     Running   0             117s
a1controller-558776cc7b-8rhdd                   1/1     Running   0             2m27s
capifcore-684b458c9b-w297x                      1/1     Running   0             2m27s
controlpanel-889b5dfbf-b8tgd                    1/1     Running   0             2m27s
db-75c5789d97-nvjtw                             1/1     Running   0             2m27s
dmaapadapterservice-0                           1/1     Running   0             2m27s
dmaapmediatorservice-0                          1/1     Running   0             2m27s
helmmanager-0                                   1/1     Running   0             2m27s
informationservice-0                            1/1     Running   0             2m27s
nonrtricgateway-7b7d485dd4-j8hnz                1/1     Running   0             2m27s
orufhrecovery-6d97d6ccf-ghknd                   1/1     Running   0             2m27s
policymanagementservice-0                       1/1     Running   0             2m27s
ransliceassurance-7d788d7556-95trk              1/1     Running   0             2m27s
rappcatalogueenhancedservice-764c47f7fb-s75hf   1/1     Running   0             2m27s
rappcatalogueservice-66c7bf7d98-2ldjc           1/1     Running   0             2m27s
rappmanager-0                                   1/1     Running   0             2m27s
dmeparticipant-84497bcbd4-jr522                 1/1     Running   0             2m27s
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
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

Troubleshooting

After successful installation, control panel shows "No Type" as policy type as shown below.

Image Removed

If there is no policy type shown and UI looks like below, then the setup can be investigated with below steps (It could be due to synchronization delay as well, It gets fixed automatically after few minutes)

Image Removed

...

Command to check pms logs

Code Block

language	bash
title	Kubernetes command to get PMS logs

kubectl logs policymanagementservice-0 -n nonrtric

Command to enable debug logs in PMS (Command below should be executed inside k8s pods or the host address needs to be updated with the relevant port forwarding)

Code Block

language	bash
title	Enabling debug logs in PMS

curl --request POST \
--url http://policymanagementservice:9080/actuator/loggers/org.onap.ccsdk.oran.a1policymanagementservice \
--header 'Content-Type: application/json' \
--data '{ "configuredLevel": "DEBUG" }'

Try removing the controller information in specific simulator configuration and verify the simulator are working without a1controller.

Code Block

language	bash
title	application_configuration.json
collapse	true

...
 {
    "name":"ric1",
    "baseUrl":"https://a1-sim-osc-0.a1-sim:8185",
    "managedElementIds":[
       "kista_1",
       "kista_2"
      ]
 },
...

...

Un-installation

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

Code Block

language	bash
title	Undeploy Nonrtric

sudo dep/bin/undeploy-nonrtric

Introduction to Helm Charts

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

For more information you could refer to below links,

...

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

...
...
...

Note

icon	false

When enabling the installRanpm switch, set the value false for installControlpanel, installInformationservice, and installNonrtricgateway. These services are installed separately in the RANPM helm charts, but with some conflicting differences.

Installation

There is a script that packs and installs the components by using the helm command. The installation uses a values override file like the one shown above. This example can be run like this:

Code Block

language	bash
title	Install Charts using the script: deploy-nonrtric.sh

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

Note

icon	false

If the "Default storage class" is not set then Kong PV and PVC creation may fail and that's specified in nonrtric/helm/kongstorage/kongvalues.yaml
Check the default StorageClass or ONLY for development proposes disable kong-postgres persistence

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 the NONRTRIC components.

Code Block

language	bash
title	Undeploy Nonrtric

sudo ./dep/bin/undeploy-nonrtric

Troubleshooting A1-Policy functions

After successful installation, control panel shows "No Type" as policy type as shown below.
Image Added

If there is no policy type shown and UI looks like below, then the setup can be investigated with below steps (It could be due to synchronization delay as well, It gets fixed automatically after few minutes)
Image Added

Verify the A1 PMS logs to make sure that the connection between A1 PMS and a1controller is successful.

Command to check pms logs
Code Block
language bash
title Kubernetes command to get PMS logs
kubectl logs policymanagementservice-0 -n nonrtric

Command to enable debug logs in PMS (Command below should be executed inside k8s pods or the host address needs to be updated with the relevant port forwarding)

Code Block

language	bash
title	Enabling debug logs in PMS

curl --request POST \
--url http://policymanagementservice:9080/actuator/loggers/org.onap.ccsdk.oran.a1policymanagementservice \
--header 'Content-Type: application/json' \
--data '{ "configuredLevel": "DEBUG" }'

Try removing the controller information in specific simulator configuration and verify the simulator are working without a1controller.

Code Block

language	bash
title	application_configuration.json
collapse	true

...
 {
    "name":"ric1",
    "baseUrl":"https://a1-sim-osc-0.a1-sim:8185",
    "managedElementIds":[
       "kista_1",
       "kista_2"
      ]
 },
...

For troubleshooting the curl command is available in the can be used in controlpanel pod.

Example of local installation

sudo kind create cluster --config - <<EOF
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
nodes:
  - role: control-plane
    extraPortMappings:
      - containerPort: 30091
        hostPort: 30091
        protocol: TCP
      - containerPort: 30093
        hostPort: 30093
        protocol: TCP
      - containerPort: 31575
        hostPort: 31575
        protocol: TCP
      - containerPort: 32080
        hostPort: 32080
        protocol: TCP
EOF

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

sed -i '/persistence:/,/existingClaim:/s/existingClaim: .*/enabled: false/' ./dep/nonrtric/helm/kongstorage/kongvalues.yaml && rm -rf ./dep/nonrtric/helm/kongstorage/templates 

./dep/smo-install/scripts/layer-0/0-setup-charts-museum.sh 

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

Version	Old Version 1	New Version Current
Changes made by	John Keeney (Ericsson EST)	Francesco Davide Lapenta
Saved on	Sept 19, 2024	Jan 13, 2025

Page Comparison

Versions Compared

Key

Prerequisites

Preparations

Requirement on Kubernetes (RANPM Installation)

Introduction to Helm Charts

Preparations

Configuration of components to install

Configuration of components to install

RANPM ONLY Installation

Prerequisites

Requirement on Kubernetes

Other requirements

Before installation

Installation(RANPM Only)

Unstallation(RANPM Only)

Exposed ports to APIs

Keycloak API

OPA rules bundle server

Information coordinator Service

Ves-Collector

Exposed ports to admin tools

Keycload admin console

Redpanda consule

Minio web

Influx db

Result of the installation

Troubleshooting

Un-installation

Introduction to Helm Charts

Installation

Installing / Uninstalling the RAN PM functions

Uninstalling

Troubleshooting A1-Policy functions

Example of local installation