Release C - Build/Run

Owned by Yennifer Chacon
Last updated: May 24, 2021 by John Keeney (Ericsson EST)
5 min read

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

All components of the Non-RT RIC (from three different repos) run inside docker containers and communicate via a docker network. Details of the architecture can be found from Release C page.

Project Requirements

  • Java 11 (make sure that JAVA_HOME environment variable points to correct Java version)

  • Docker and docker-compose (latest)

  • Maven 3.6

    • There are several build-time dependencies for ONAP Maven modules.
      Your Maven build settings will need to access the ONAP Maven repos, as described on this ONAP wiki page

Build Code

Build nonrtric containers

  • Download the nonrtric repo: 
     git clone "https://gerrit.o-ran-sc.org/r/nonrtric"
  • Checkout cherry branch: 
     git checkout --track origin/cherry

Configure policy-agent

To support local test with two separate Near-RT RIC simulator instances:  

  • create a new nonrtric/policy-agent/config/application_configuration.json with the configuration below
  • The controller hostname and port values come from and must match those defined in nonrtric/docker-compose/sdnc/docker-compose.yml
  • any defined ric names must match the given docker container names in near-RT 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"
            ]
         }
      ]
   }
}


update policy-agent/Dockerfile: 

ADD /config/application_configuration.json /opt/app/policy-agent/data/application_configuration.json_example

to

ADD /config/application_configuration.json /opt/app/policy-agent/data/application_configuration.json

Build the code and create docker images

To build docker images of sdnc-a1-controller, policy-agent, enrichment coordinator service and r-app-catalogue:

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

If the build was successful images with following name and tag shall be built, use the command 'docker images' to view newly built images in the local docker registry.

$ docker images
o-ran-sc/nonrtric-r-app-catalogue                   1.0.1-SNAPSHOT 
o-ran-sc/nonrtric-enrichment-coordinator-service    1.0.1-SNAPSHOT 
o-ran-sc/nonrtric-policy-agent                      2.1.1-SNAPSHOT

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 .

You can check that the image is in docker using:

$ docker images
o-ran-sc/nonrtric-r-app-catalogue                  1.0.1-SNAPSHOT   
o-ran-sc/nonrtric-enrichment-coordinator-service   1.0.1-SNAPSHOT   
o-ran-sc/nonrtric-policy-agent                     2.1.1-SNAPSHOT  
near-rt-ric-simulator                              latest

Build NONRTRIC / A1 Policy control panel container

Download the nonrtric repo (defaults to master branch): 

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

Verify controlpanel configuration

(warning) Note that nonrtric-controlpanel/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: 
    cd nonrtric/docker-compose/sdnc
  • 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 followed e.g. by using command 

docker exec a1-controller sh -c "tail -f /opt/opendaylight/data/log/karaf.log"

Open Daylight GUI

Run Near-RT RIC A1 Simulator Docker Containers

  • Start docker containers for each ric defined in nonrtric/policy-agent/config/application_configuration.json 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 -p 8185:8185 -e A1_VERSION=OSC_2.1.0 -e ALLOW_HTTP=true --network=nonrtric-docker-net --name=ric1 near-rt-ric-simulator:latest
    docker run -p 8086:8085 -p 8186:8185 -e A1_VERSION=OSC_2.1.0 -e ALLOW_HTTP=true --network=nonrtric-docker-net --name=ric2 near-rt-ric-simulator:latest
  • Change directory:  
    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 once A1 Controller and simulators have been fully started: 
    docker run -p 8081:8081 -p 8433:8433 --network=nonrtric-docker-net --name=policy-agent-container o-ran-sc/nonrtric-policy-agent:2.1.1-SNAPSHOT

  • Once policy-agent is up and running, it establishes connections to all configured Near-RT RICs
  • If policy-agent-container is configured to log at DEBUG level, the following logs should appear to log to show that connection to the configured RICs has been established successfully via A1 Controller.

policy-agent Swagger API

For troubleshooting/verification purposes you can view/access the policy-agent swagger API from url: http://localhost:8081/swagger-ui.html

Run Enrichment Service Docker Container

  • Run docker container using this command once A1 Controller and simulators have been fully started: 

docker run -p 8083:8083 -p 8434:8434 --network=nonrtric-docker-net --name=enrichment-service-container o-ran-sc/nonrtric-enrichment-coordinator-service:1.0.1-SNAPSHOT

  • By running these curl commands objects can be added:

    • Add new EI type:

      curl -H 'Content-Type: application/json' -X PUT \
	-d '{"ei_job_data_schema":{"$schema":"http://json-schema.org/draft-07/schema#", "title":"STD_Type1_1.0.0", "description":"EI-Type 1", "type":"object"}}' \
	http://localhost:8083/ei-producer/v1/eitypes/type1

    • Add new EI Producer

      curl -H 'Content-Type: application/json' -X PUT \
	-d '{"supported_ei_types":["type1"],"ei_job_callback_url":"http://producer:80/","ei_producer_supervision_callback_url":"http://producer:80/"}' \
	http://localhost:8083/ei-producer/v1/eiproducers/prod-a

    • Add new EI Job

      curl -H 'Content-Type: application/json' -X PUT \
	-d '{"eiTypeId":"type1","jobResultUri":"https://ricsim_g3_1:8185/datadelivery","jobOwner":"ricsim_g3_1","jobStatusNotificationUri":"https://callback-receiver:8091/callbacks/job1-status","jobDefinition":{"jobparam1":"value1_job1","jobparam2":"value2_job1","jobparam3":"value3_job1"}}' \
	http://localhost:8083/A1-EI/v1/eijobs/job1

Run Non-RT RIC Control Panel Docker Container

Run docker container using this command: 

docker run -p 8080:8080 --network=nonrtric-docker-net o-ran-sc/nonrtric-controlpanel:2.1.0-SNAPSHOT

Open NONRTRIC / A1 Policy Control Panel UI

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

http://localhost:8080/