Table of Contents

maxLevel	1

Project Requirements

docker and docker-compose (latest)
curl (or similar)
Additional optional requirements if using the "Helm Manager" function
- kubernetes v1.19+
- kubectl with admin access to kubernetes (e.g., minikube, docker-desktop kubernetes etc)
- helm with access to kubernetes - this is only applicable when running the Helm Manager example operations
Addition optional requirement if using the "DMaaP Adapter" or "DMaap Mediator Producer" services
- DMaaP MR (See: Deploy DMaaP message router in nonrtric)
- kafka (latest) - only for DMaaP Adapter Service, and optional

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.

H Release - Images & Tags

H Release - Docker Images

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 (Near-RT RIC simulator)	8085/8185, 8086/8186, 8087/8187
Information Coordinator Service	8083/8434
Non-RT RIC Control Panel	8080/8880
SDNC A1-Controller	8282/8443
Gateway	9090 (only http)
App Catalogue Service	8680/8633
Helm Manager	8112 (only http)
DMaaP Mediator Producer	9085/9185
DMaaP Adapter Service	9087/9187
SME-CapifCore	8090 (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
Anchor
runa1pms
runa1pms

Test locally with three separate A1 simulator instances, each running a one of the three available A1 Policy interface versions:

Create an application_configuration.json file with the configuration below. This will configure the A1 Policy Management Service to use the simulators for the A1 interface
Note: Any defined ric names must match the given docker container names in near-RT RIC simulator startup, see Run A1 Simulator Docker Containers

The A1 Policy Management Service can be configured to support A1 connection via an SDNC A1-Controller for some or all rics/simulators. It is optional to access the near-RT-RIC through an SDNC A1-Controller.
This is enabled in the configuration file using the optional "controller" parameter for each ric entry. If all configured rics bypass the A1-Controller (do not have "controller" values) then the "controller" object at the top of the configuration can be omitted. If all configured rics bypass the SDNC A1-Controller there is no need to start an SDNC A1-Controller.

...

Note: If the policy management service is started with config for the SDNC A1 Controller (the second config option), do the steps described in section Run the SDNC A1 Controller Docker Container below before proceeding.

...

Expected output (not that all simulators - ric1,ric2 and ric3 will indicate "state":"UNAVAILABLE" until the simulators has been started in Run A1 Simulator Docker Containers):

{"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)
Anchor
runsdnc
runsdnc

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

Create the docker compose file - be sure to update image for the a1controller to the one listed for SDNC A1 Controller in the table on the top of this page.
docker-compose.yaml

...

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

Run the A1 Simulator (Near-RT-RIC simulator) Docker Containers
Anchor
runsimulators
runsimulators

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

...

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

Run the Information Coordinator Service Docker Container
Anchor
runics
runics

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 NONRTRIC Gateway and NONRTRIC Control Panel Docker Container

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

...

The web-based 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 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 DMaaP MR 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:

...

This is a basic start command without helm. See repo README Release H - CAPIF and the README file in the sme repository for more options.

Check that the component has started.

curl localhost:8090 Hello, World!

Run RANPM

There is no Docker compose file for now. Might have one later.

Show all results

Space shortcuts

Page tree

Versions Compared

Old Version 8

New Version Current

Key

Project Requirements

Images

H Release - Images & Tags

Ports

Prerequisites

Run the A1 Policy Management Service Docker Container
Anchor
runa1pms
runa1pms

Run the SDNC A1 Controller Docker Container (ONAP SDNC)
Anchor
runsdnc
runsdnc

Run the A1 Simulator (Near-RT-RIC simulator) Docker Containers
Anchor
runsimulators
runsimulators

Run the Information Coordinator Service Docker Container
Anchor
runics
runics

Run the NONRTRIC Gateway and NONRTRIC Control Panel Docker Container

Run the App Catalogue Service Docker Container

Run the App Catalogue (Enhanced) Service Docker Container

Run the Helm Manager Docker Container

Run the DMaaP Adapter Service Docker Container

Run the DMaaP Mediator Producer Docker Container

Run SME CAPIF Core

Run RANPM

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 8

New Version Current

Key

Project Requirements

Images

H Release - Images & Tags

Ports

Prerequisites

Run the A1 Policy Management Service Docker Container Anchorruna1pmsruna1pms

Run the SDNC A1 Controller Docker Container (ONAP SDNC) Anchorrunsdncrunsdnc

Run the A1 Simulator (Near-RT-RIC simulator) Docker Containers Anchorrunsimulatorsrunsimulators

Run the Information Coordinator Service Docker Container Anchorrunicsrunics

Run the NONRTRIC Gateway and NONRTRIC Control Panel Docker Container

Run the App Catalogue Service Docker Container

Run the App Catalogue (Enhanced) Service Docker Container

Run the Helm Manager Docker Container

Run the DMaaP Adapter Service Docker Container

Run the DMaaP Mediator Producer Docker Container

Run SME CAPIF Core

Run RANPM

Run the A1 Policy Management Service Docker Container
Anchor
runa1pms
runa1pms

Run the SDNC A1 Controller Docker Container (ONAP SDNC)
Anchor
runsdnc
runsdnc

Run the A1 Simulator (Near-RT-RIC simulator) Docker Containers
Anchor
runsimulators
runsimulators

Run the Information Coordinator Service Docker Container
Anchor
runics
runics