kubernetes v1.19 +
docker and docker-compose (latest)
git
Text editor, e.g. vi, notepad, nano, etc.
helm
helm3
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. 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"

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

Code Block

language	bash
title	Clone repo & submodules

#Submodule 'ranpm' (https://gerrit.o-ran-sc.org/r/nonrtric/plt/ranpm) registered for path 'ranpm'
#Submodule 'ric-dep' (https://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"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.

Configuration of components to install

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

Code Block

language	bash
title	Edit override file

<editor> 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: true
  installKong: true
  installDmaapadapterservice: true
  installDmaapmediatorservice: true
  installHelmmanager: true
  installOrufhrecovery: true
  installRansliceassurance: true
  installCapifcore: true
  installServicemanager: true
  # When enabling Ranpm, switchset tovalue 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

...
...
...

Note

icon	false

When enabling Ranpm switch to false the installRanpm switch, set the false for installControlpanel, installInformationservice, and installNonrtricgateway. Because these These services are getting installed by separately in the RANPM helm charts as well with a different Release Name., 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

Deploy TEIV

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

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

RANPM ONLY 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 setup requires a fair amount of computer resourcesdeployment 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)

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

Other requirements

helm3
bash
cmd library 'envsubst' must be installed (check by cmdinstallation using command: 'type envsubst' )cmd
library 'jq' must be installed ( check by cmdinstallation 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

...

Build the following images (Build instruction in each directory)

https-server
pm-rapp

Installation (RANPM Only)

...

The following scripts are provided for installing (install-nrt.sh mush must be installed 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 rapp that subscribe skeleton rApp-placeholder that subscribes and print out received data

...

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

...

Uninstalling (RANPM Only)

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

Exposed ports to APIs

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

...

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

...

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 filestorefile-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 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> 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

...

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

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 Modified

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"
      ]
 },
...

curl can be used in control panel pod.

...

Uninstalling

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

...

For more information you could refer to below links,

...

sh

...

Version	Old Version 7	New Version 8
Changes made by	Francesco Davide Lapenta	John Keeney (Ericsson EST)
Saved on	Aug 16, 2024	Oct 18, 2024

Page Comparison

Versions Compared

Key

Introduction to Helm Charts

Preparations

Configuration of components to install

Installation

RANPM ONLY Installation

Prerequisites

Requirement on Kubernetes

Other requirements

Before installation

Installation (RANPM Only)

Uninstalling (RANPM Only)

Exposed ports to APIs

OPA rules bundle server

Information coordinator Service

Ves-Collector

Exposed ports to admin tools

Redpanda consule

Minio web

Influx db

Result of the installation

Uninstalling

Introduction to Helm Charts