Versions Compared

Key

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

UPDATE IN PROGRESS

This page describes how to run various NONRTRIC functions in Docker.

...

Details of the architecture can be found from Release IJ page.

Table of Contents
maxLevel1

...

In general, there is no need to build the images manually unless there are code changes made by the user, so release images should be used. Instruction on how to build all components, see. Release I J - Build.

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. 

...

J Release - Images & Tags

...

docker run --rm -v <absolute-path-to-file>/application_configuration.json:/opt/app/policy-agent/data/application_configuration.json -p 8081:8081 -p 8433:8433 --network=nonrtric-docker-net --name=policy-agent-container nexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-a1policymanagementservice:2.68.0

Wait 1 minute to allow the container to start and to read the configuration. Then run the command below another terminal. The output should match the configuration in the file - all three rics (ric1, ric2 and ric3) should be included in the output. Note that each ric has the state "UNAVAILABLE" until the simulators are started.

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.

NOTE: Use below Endpoint to use a1policymanagement V2

curl localhost:8081/a1-policy/v2/rics

...

{"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"}]}

...

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 NOTE: Use below Endpoint to use a1policymanagement V3

curl localhost:8081/a1-policy-management/v1/rics

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":[{"ricId":"ric1","managedElementIds":["kista_1","kista_2"],"policyTypeIds":[],"state":"UNAVAILABLE"},{"ricId":"ric3","managedElementIds":["kista_5","kista_6"],"policyTypeIds":[],"state":"UNAVAILABLE"},{"ricId":"ric2","managedElementIds":["kista_3","kista_4"],"policyTypeIds":[],"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 

Code Block
titledocker-compose.yaml
version: '3'
 
networks:
  default:
    external: true
    name: nonrtric-docker-net
 
services:
  db:
    image: nexus3.o-ran-sc.org:10001/mariadb:10.5
    container_name: sdncdb
    networks:
      - default
    ports:
      - "3306"
    environment:
      - MYSQL_ROOT_PASSWORD=itsASecret
      - MYSQL_ROOT_HOST=%
      - MYSQL_USER=sdnctl
      - MYSQL_PASSWORD=gamma
      - MYSQL_DATABASE=sdnctl
    logging:
      driver:   "json-file"
      options:
        max-size: "30m"
        max-file: "5"
 
  a1controller:
    image: nexus3.onap.org:10001/onap/sdnc-image:2.56.41
    depends_on :
      - db
    container_name: a1controller
    networks:
      - default
    entrypoint: ["/opt/onap/sdnc/bin/startODL.sh"]
    ports:
      - 8282:8181
      - 8443:8443
    links:
      - db:dbhost
      - db:sdnctldb01
      - db:sdnctldb02
    environment:
      - MYSQL_ROOT_PASSWORD=itsASecret
      - MYSQL_USER=sdnctl
      - MYSQL_PASSWORD=gamma
      - MYSQL_DATABASE=sdnctl
      - SDNC_CONFIG_DIR=/opt/onap/sdnc/data/properties
      - SDNC_BIN=/opt/onap/sdnc/bin
      - ODL_CERT_DIR=/tmp
      - ODL_ADMIN_USERNAME=admin
      - ODL_ADMIN_PASSWORD=Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
      - ODL_USER=admin
      - ODL_PASSWORD=Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
      - SDNC_DB_INIT=true
      - A1_TRUSTSTORE_PASSWORD=a1adapter
      - AAI_TRUSTSTORE_PASSWORD=changeit
    logging:
      driver:   "json-file"
      options:
        max-size: "30m"
        max-file: "5"

...

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.

ric1

docker run --rm --network=nonrtric-docker-net -p 8085:8085 -p 8185:8185 -e A1_VERSION=OSC_2.1.0 -e ALLOW_HTTP=true--name=ric1 nexus3.

...

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

ric2

docker run --rm --network=nonrtric-docker-net -p 80858086:8085 -p 81858186:8185 -e A1_VERSION=OSCSTD_21.1.0 3 -e ALLOW_HTTP=true--name=ric1 ric2 nexus3.o-ran-sc.org:10002/o-ran-sc/a1-simulator:2.57.0

ric2ric3

docker run --rm --network=nonrtric-docker-net -p 80868087:8085 -p 81868187:8185 -e A1_VERSION=STD_12.10.3 0 -e ALLOW_HTTP=true --name=ric3 nexus3.o--name=ric2 nexus3.o-ran-sc.org:10002/o-ran-sc/a1-simulator:2.5.0

ric3

...

docker run --rm --network=nonrtric-docker-net -p 8087:8085 -p 8187:8185 -e A1_VERSION=STD_2.0.0 -e ALLOW_HTTP=true --name=ric3 nexus3.o-ran-sc.org:10002/o-ran-sc/a1-simulator:2.5.0

...

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

Wait at least one minute to let the policy management service synchronise the rics. Then run the command below another terminal. The output should match the configuration in the file. Note that each ric now has the state "AVAILABLE".

NOTE: Use below Endpoint to use a1policymanagement V2

curl localhost:8081/a1-policy/v2/rics

Expected output - all state should indicated AVAILABLE:

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

NOTE: Use below Endpoint to use a1policymanagement V3

curl localhost:8081/a1-policy-management/v2v1/rics

Expected output - all state should indicated AVAILABLE:

{"rics":[{"ric_idricId":"ric1","managed_element_idsmanagedElementIds":["kista_1","kista_2"],"policytype_idspolicyTypeIds":[],"state":"AVAILABLE"},{"ric_idricId":"ric3","managed_element_idsmanagedElementIds":["kista_5","kista_6"],"policytype_idspolicyTypeIds":[],"state":"AVAILABLE"},{"ric_idricId":"ric2","managed_element_idsmanagedElementIds":["kista_3","kista_4"],"policytype_idspolicyTypeIds":[""],"state":"AVAILABLE"}]}

...

List the synchronised types using a1policymanagement V2 endpoint:

curl localhost:8081/a1-policy/v2/policy-types

...

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

List the synchronised types using a1policymanagement V3 endpoint:

curl localhost:8081/a1-policy-management/v1/policy-types

Expected output:

[{"policyTypeId": "", "nearRtRicId": "ric2"},{"policyTypeId":"123","nearRtRicId": "ric1"}, {"policyTypeId":"std_pt1","nearRtRicId": "ric3"}]

Run the Information Coordinator Service Docker Container
Anchor
runics
runics

...

docker run --rm --network=nonrtric-docker-net -p 8083:8083 -p 8434:8434 --name=information-service-container nexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-informationcoordinatorservice:1.57.0

Verify that the Information Coordinator Service is started and responding (response is an empty array).

...

docker run --rm -p 9096:9096 -p 9196:9196 -e ALLOW_HTTP=true --network=nonrtric-docker-net --name=rapp-catalogue-service-enhanced nexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-rappcatalogue-enhanced:1.2.0.1

Verify that the service is up and running

...

docker run --rm\
-v<absolute-path-to-config-file>/application.yaml:/opt/app/dmaap-adapter-service/config/application.yaml \
-v<absolute-path-to-config-file>/application_configuration.json:/opt/app/dmaap-adapter-service/data/application_configuration.json \
-p 9086:8084 -p 9087:8435 --network=nonrtric-docker-net --name=dmaapadapterservice nexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-dmaapadapter:1.34.0

Setup jobs to produce data according to the types in application_configuration.json

...

Start the CAPIF Core (Release HJ) in a separate shell with the following command:

docker run --rm -v \
<absolute-path-to-config-file>/type_config.json:/configs/type_config.json \
-p 8090:8090 --network=nonrtric-docker-net --name=capifcore \
nexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-plt-capifcore:1.3.1.0

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

...