Release B - Build/Run

This page describes how to get the release B version of NonRTRIC up and running locally with two separate NearRT-RIC simulator docker containers providing OSC_2.1.0 version of A1 interface.

All four components of the NonRTRIC (from three different repos) run inside docker containers and communicate via a docker network. Details of the architecture can be found from Release B page.

Project Requirements

Java 11 (make sure that JAVA_HOME environment variable points to correct Java version)
Maven 3.6
Docker (latest)

Build Code

Build nonrtric containers

Download the nonrtric repo (defaults to master branch):

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

Configure policy-agent

To support local test with two separate NearRT-RIC simulator instances the following modifications must be done:

change the 'a1ControllerBaseUrl' in nonrtric/policy-agent/config/application.yaml file of policy-agent to http://a1-controller-container:8181
- The above hostname and port values come from and must match those defined in nonrtric/sdnc-a1-controller/oam/installation/src/main/yaml/docker-compose.yml
- The default URL to be replaced (http://sdnc.onap:8282) is used in Kubernetes-based ONAP deployment

The following step is required only if you want to run more than the default ric1 nearRT-RIC simulator instance
- replace the content of nonrtric/policy-agent/config/application_configuration.yaml with the configuration below
- any defined ric names must match the given docker container names in nearRT-RIC simulator startup - port is always the simulator's internal 8085

application_configuration.yaml

{
   "config": {
      "//description": "Application configuration",
      "ric": [
         {
            "name": "ric1",
            "baseUrl": "http://ric1:8085/",  
            "managedElementIds": [
               "kista_1",
               "kista_2"
            ]
         },
         {
            "name": "ric2",
            "baseUrl": "http://ric2:8085/",
            "managedElementIds": [
               "kista_3",
               "kista_4"
            ]
         }
      ]
   }
}

Build the code and create docker images

To build docker images of sdnc-a1-controller and policy-agent:

cd nonrtric
mvn clean install -Dmaven.test.skip=true

Build near-rt-ric-simulator container

Download the near-rt-ric-simulator repo (defaults to master branch):

     git clone "https://gerrit.o-ran-sc.org/r/sim/a1-interface"

Create docker image

To create docker image near-rt-ric-simulator (note that the given image name must match the name given in docker startup later):

cd a1-interface/near-rt-ric-simulator
docker build -t near-rt-ric-simulator:latest .

Build dashboard container

Download the nonrtric repo (defaults to master branch):

     git clone "https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel"

Verify dashboard configuration

Note that nonrtric/dashboard/webapp-backend/src/main/resources/application.properties default property value policycontroller.url.prefix = http://policy-agent-container:8081 assumes that policy agent is started with name policy-agent-container and exposes port 8081 (as is done below)!

Build the code and create docker image

cd nonrtric-controlpanel
mvn clean install -Dmaven.test.skip=true

Run A1 Controller Docker Container

A1 Controller must be started first to set up docker network

Change directory to:

cd nonrtric/sdnc-a1-controller/oam/installation/src/main/yaml

Run docker container using the command below
```
docker-compose up a1-controller
```
- the container is ready once message "Healthcheck Passed in XX seconds." appears
- note that certificate-related errors "cp: can't stat '/opt/opendaylight/current/certs/*': No such file or directory" and "Error: File not found in path entered" can be ignored

The Karaf logs of A1 controller can be seen using the following commands:

docker exec -it a1-controller-container sh
cd opt/opendaylight/data/log/
tail -f karaf.log

Run Near-RT-RIC Simulator Docker Containers

Start docker containers for each ric defined in nonrtric/policy-agent/config/application_configuration.yaml in previous steps (in this example for ric1 and ric2) and providing A1 interface version OSC_2.1.0 with the following commands::

docker run -p 8085:8085 -e A1_VERSION=OSC_2.1.0 --network=nonrtric-docker-net --name=ric1 near-rt-ric-simulator:latest
docker run -p 8086:8085 -e A1_VERSION=OSC_2.1.0 --network=nonrtric-docker-net --name=ric2 near-rt-ric-simulator:latest

Change directory to:

cd a1-interface/near-rt-ric-simulator/test/OSC_2.1.0/jsonfiles

Put an example policy_type into the started near-rt-ric-simulator instances by running these curl commands (in this example to ric1 exposed to port 8085 and ric2 exposed to port 8086):

curl -X PUT -v "http://localhost:8085/a1-p/policytypes/123" -H "accept: application/json" -H "Content-Type: application/json" --data-binary @pt1.json
curl -X PUT -v "http://localhost:8086/a1-p/policytypes/123" -H "accept: application/json" -H "Content-Type: application/json" --data-binary @pt1.json

Run Policy-agent Docker Container

Run docker container using this command:

docker run -p 8081:8081 --network=nonrtric-docker-net --name=policy-agent-container o-ran-sc/nonrtric-policy-agent:1.0.0-SNAPSHOT

Note on automatic A1 Client selection

Once policy-agent is up and running, it establishes connections to all configured NearRT-RICs. It has multiple A1 clients to select from and selection is done dynamically based on connectivity. Selection of A1 client is not clearly visible for user, but policy-agent logs can be grepped to see which client was selected.

The two grepping examples below show how either SDNC_OSC A1 client or STD A1 client was selected - these translate into options A and B described on the Testing End to End call in release B page.

SDNC A1 Client

$ docker logs policy-agent | grep "protocol version"
2020-04-03 12:20:00.239 DEBUG 1 --- [or-http-epoll-1] o.o.policyagent.clients.A1ClientFactory  : Established protocol version:OSC_V1 for Ric: ric1
2020-04-03 12:20:00.248 DEBUG 1 --- [or-http-epoll-2] o.o.policyagent.clients.A1ClientFactory  : Established protocol version:OSC_V1 for Ric: ric2

STD A1 Client

$ docker logs policy-agent | grep "protocol version"
2020-04-03 12:20:00.239 DEBUG 1 --- [or-http-epoll-1] o.o.policyagent.clients.A1ClientFactory  : Established protocol version:STD_V1 for Ric: ric1
2020-04-03 12:20:00.248 DEBUG 1 --- [or-http-epoll-2] o.o.policyagent.clients.A1ClientFactory  : Established protocol version:STD_V1 for Ric: ric2

Run Non-RT-RIC Dashboard Docker Container