Versions Compared

Old Version 22

changes.mady.by.user Björn Magnusson

Saved on

compared with

New Version 23

changes.mady.by.user John Keeney

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page describes how to get the release F G version of Non-RT RIC up and running locally with locally with three separate A1 simulator (previously called Near-RT RIC A1 Interface) docker containers providing STD_1.1.3, STD_2.0.0 and OSC_2.1.0 versions of the A1 interface.

All components of the Non-RT RIC run as docker containers and communicate via a private docker network with container ports, ports also available on localhost. Details of the architecture can be found from Release G page.


Table of Contents

Project Requirements

  • Docker and docker-compose (latest)

  • kubectl with admin access to kubernetes (minikube, docker-desktop kubernetes etc)  -  this is only applicable when running the Helm Manager
  • helm with access to kubernetes - this is only applicable when running the Helm Manager example operations

Images

The images used for running the Non-RT RIC can be selected from the table below depending on if the images are built manually (snapshot image) or if release images shall be used.

...

The run commands throughout this page uses the release images and tags. Replace the release images/tags in the container run commands in the instructions if manually-built snapshot images are desired. 

G Maintenance Release images

Component

Image

Tag

A1 Policy Management Service

nexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-a1policymanagementservice

2.5.0
Information Coordinator Service nexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-informationcoordinatorservice1.4.0
NONRTRIC Control Panel

nexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-controlpanel

2.4.0
Gatewaynexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-gateway 1.0.0
A1-Simulator

nexus3.o-ran-sc.org:10002/o-ran-sc/a1-simulator

2.4.0

R-APP Catalogue

nexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-rappcatalogue

1.1.0
R-APP Catalogue Enhancednexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-rappcatalogue-enhanced1.0.1
DMaaP Adapternexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-dmaapadapter1.2.0
DMaaP Mediatornexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-dmaapmediatorproducer1.1.0
Helm Managernexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-helmmanager1.2.0
Auth Token Fetchernexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-auth-token-fetch1.0.0
CAPIF Corenexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-capifcore:1.0.01.0.0
O-DU Slice Assurancenexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-rapp-ransliceassurance1.2.0
O-DU Slice Assurancenexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-rapp-ransliceassurance-icsversion1.1.0
O-RU FH Recoverynexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-rapp-orufhrecovery1.1.0
O-RU FH Recoverynexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-rapp-orufhrecovery-consumer1.1.0

Note: A version of this table appears Integration&Testing - G Release Docker Image List - NONRTRIC (G-Release). This is the authoritative version! 

Ports

The following ports will be allocated and exposed to localhost for each component. If other port(s) are desired, then the ports need to be replaced in the container run commands in the instructions further below.

...

Component

Port exposed to localhost (http/https)

A1 Policy Management Service

8081/8443

A1 Simulator (previously called Near-RT RIC A1 Interface) 

8085/8185,  8086/8186, 8087/8187

Information Coordinator Service

8083/8434

Non-RT RIC Control Panel

8080/8880

SDNC A1-Controller

8282/8443

Gateway9090 (only http)
App Catalogue Service8680/8633
Helm Manager8112 (only http)
Dmaap Mediator Producer9085/9185
Dmaap Adapter Service

9087/9187

Capifcore8090 (only http)


Prerequisites

The containers need to be connected to docker network in order to communicate with each other.

...

docker network create nonrtric-docker-net

Run the A1 Policy Management Service Docker Container

To support local test with three separate A1 simulator (previously called Near-RT RIC A1 Interface) instances, each running a one of the three available A1 Policy interface versions:  

...

{"rics":[{"ric_id":"ric1","managed_element_ids":["kista_1","kista_2"],"policytype_ids":[],"state":"UNAVAILABLE"},{"ric_id":"ric3","managed_element_ids":["kista_5","kista_6"],"policytype_ids":[],"state":"UNAVAILABLE"},{"ric_id":"ric2","managed_element_ids":["kista_3","kista_4"],"policytype_ids":[],"state":"UNAVAILABLE"}]}

Run the SDNC A1 Controller Docker Container (ONAP SDNC)

This step is only applicable if the configuration for the Policy Management Service include the SDNC A1 Controller (second config option), see Run the Policy Management Service Docker Container.

...

docker execa1controller sh -c "tail -f /opt/opendaylight/data/log/karaf.log"

Run the A1 Simulator (previously called Near-RT RIC A1 Interface) Docker Containers

Start a simulator for each ric defined in in the application_configuration.json created in Run the Policy Management Service Docker Container. Each simulator will use one of the currently available A1 interface versions.

...

{"policytype_ids":["","123","std_pt1"]}

Run the Information Coordinator Service Docker Container

Run the following command to start the information coordinator service.

...

For troubleshooting/verification purposes you can view/access the full swagger API from url: http://localhost:8083/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config

Run the Non-RT RIC Gateway and Control Panel Docker Container

The Gateway exposes the interfaces of the Policy Management Service and the Information Coordinator Service to a single port of the gateway. This single port is then used by the control panel to access both services.

...

The webbased UI can be accessed by pointing the web-browser to this URL: 

http://localhost:8080/

Run the App Catalogue Service Docker Container

Start the App Catalogue Service by the following command.

...

curl localhost:8680/services

Expected output:

[ ]


Run the App Catalogue Enhanced Service Docker Container

Start the App Catalogue Enhanced Service by the following command.

...

curl localhost:9096/rappcatalogue

Expected output:

[ ]


Run the Helm Manager Docker Container

Note: Access to kubernetes is required as stated the requirements on the top of this page.

...

$ ./test.sh docker
 
Start test
================
Get apps - empty
================
curl -sw %{http_code} http://helmadmin:itisasecret@localhost:8112/helm/charts
 Curl OK
  Response: 200
  Body: {"charts":[]}
 
================
Add repo
================
curl -sw %{http_code} http://helmadmin:itisasecret@localhost:8112/helm/repo -X POST -H Content-Type:application/json -d @cm-repo.json
 Curl OK
  Response: 201
  Body:
 
============
Onboard app
===========
curl -sw %{http_code} http://helmadmin:itisasecret@localhost:8112/helm/onboard/chart -X POST -F chart=@simple-app-0.1.0.tgz -F values=@simple-app-values.yaml -F info=<simple-app.json
 Curl OK
  Response: 200
  Body:
 
=====================
Get apps - simple-app
=====================
curl -sw %{http_code} http://helmadmin:itisasecret@localhost:8112/helm/charts
 Curl OK
  Response: 200
  Body: {"charts":[{"releaseName":"simpleapp","chartId":{"name":"simple-app","version":"0.1.0"},"namespace":"ckhm","repository":{"repoName":"cm","protocol":null,"address":null,"port":null,"userName":null,"password":null},"overrideParams":null}]}
 
===========
Install app
===========
curl -sw %{http_code} http://helmadmin:itisasecret@localhost:8112/helm/install -X POST -H Content-Type:application/json -d @simple-app-installation.json
 Curl OK
  Response: 201
  Body:
 
=====================
Get apps - simple-app
=====================
curl -sw %{http_code} http://helmadmin:itisasecret@localhost:8112/helm/charts
 Curl OK
  Response: 200
  Body: {"charts":[{"releaseName":"simpleapp","chartId":{"name":"simple-app","version":"0.1.0"},"namespace":"ckhm","repository":{"repoName":"cm","protocol":null,"address":null,"port":null,"userName":null,"password":null},"overrideParams":null}]}
 
=================================================================
helm ls to list installed app - simpleapp chart should be visible
=================================================================
NAME        NAMESPACE   REVISION    UPDATED                                 STATUS      CHART               APP VERSION
simpleapp   ckhm        1           2022-06-27 21:18:27.407666475 +0000 UTC deployed    simple-app-0.1.0    1.16.0    
 
==========================================
sleep 30 - give the app some time to start
==========================================
============================
List svc and  pod of the app
============================
NAME                   TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE
simpleapp-simple-app   ClusterIP   10.98.120.189   <none>        80/TCP    30s
NAME                                    READY   STATUS    RESTARTS   AGE
simpleapp-simple-app-675f44fc99-qsxr6   1/1     Running   0          30s
 
========================
Uninstall app simple-app
========================
curl -sw %{http_code} http://helmadmin:itisasecret@localhost:8112/helm/uninstall/simple-app/0.1.0 -X DELETE
 Curl OK
  Response: 204
  Body:
 
===========================================
sleep 30 - give the app some time to remove
===========================================
============================================================
List svc and  pod of the app - should be gone or terminating
============================================================
No resources found in ckhm namespace.
No resources found in ckhm namespace.
 
=====================
Get apps - simple-app
=====================
curl -sw %{http_code} http://helmadmin:itisasecret@localhost:8112/helm/charts
 Curl OK
  Response: 200
  Body: {"charts":[{"releaseName":"simpleapp","chartId":{"name":"simple-app","version":"0.1.0"},"namespace":"ckhm","repository":{"repoName":"cm","protocol":null,"address":null,"port":null,"userName":null,"password":null},"overrideParams":null}]}
 
============
Delete chart
===========
curl -sw %{http_code} http://helmadmin:itisasecret@localhost:8112/helm/chart/simple-app/0.1.0 -X DELETE
 Curl OK
  Response: 204
  Body:
 
================
Get apps - empty
================
curl -sw %{http_code} http://helmadmin:itisasecret@localhost:8112/helm/charts
 Curl OK
  Response: 200
  Body: {"charts":[]}
 
Test result  All tests ok
End of test


Run the

...

DMaaP Adapter Service Docker Container

The Dmaap DMaaP Adapter Service needs two configurations files, one for the application specific parameters and one for the types the application supports.

...

Data posted on the kafka topic unauthenticated.dmaapadp_kafka.text will be delivered to the path as specified in the job2.json.

Run the Dmaap Mediator Producer Docker Container

The Dmaap Mediator Producer needs one configuration file for the types the application supports.

...

Data posted on the message router topic unauthenticated.dmaapmed.json will be delivered to the path as specified in the job3.json.


Run SME CAPIF Core

Start the CAPIF Core in a separate shell with the following command:

...

curl localhost:8090
Hello, World!


Run use cases

Within NON-RT RIC a number of use case implementations are provided. Follow the links below to see how to run them.

...