This page describes how to get the Guilin Honolulu release version of A1-Policy functions up and running locally with two separate Near-RT RIC A1 simulator docker containers providing OSC_2.1.0 version of A1 interface.
All four components of these Non-RT RIC function run as docker containers and communicate via a private docker network. Details of the architecture can be found from Guilin from Honolulu Release page.
Project Requirements
Build Code
Build Policy Management Service container
Configure A1 Policy Management Service
Build the code and create docker image
Build A1 Adapter for Controller
Build the code and create docker images
Run Controller with OSC A1 Adapter
Run Near-RT RIC A1 Simulator Docker Containers
Run A1 Policy Management Service Docker Container
A1 Policy Management Service Swagger API
Run OSC Non-RT RIC Control Panel Docker Container
Open OSC NONRTRIC / A1 Policy Control Panel UI
Project Requirements
Java 11 (make sure that JAVA_HOME environment variable points to correct Java version)
Maven 3.6
Docker and docker-compose (latest)
Build Code
Build A1 Policy Management Service container
Download the ccsdk/oran repo, guilin honolulu branch:
Code Block language bash $ git clone "https://gerrit.onap.org/r/ccsdk/oran" -b guilinhonolulu
Configure the A1 Policy Management Service
To support local test with two separate Near-RT RIC simulator instances:
...
Code Block | ||||
---|---|---|---|---|
| ||||
{ "config": { "//description": "Application configuration", "controller": [ { "name": "controller1", "baseUrl": "http://sdnc_controller_container:8181", "userName": "admin", "password": "Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U" } ], "ric": [ { "name": "ric1", "baseUrl": "http://ric1:8085/", "controller": "controllercontroller1", "managedElementIds": [ "kista_1", "kista_2" ] }, { "name": "ric2", "baseUrl": "http://ric2:8085/", "controller": "controllercontroller1", "managedElementIds": [ "kista_3", "kista_4" ] }, ]{ } } |
Build the code and create docker image
To build docker image of the policy management service:
Code Block | ||
---|---|---|
| ||
$ cd oran/a1-policy-management/ $ mvn clean install -Dmaven.test.skip=true |
If the build is successful an image with following name and tag shall be built, use the command 'docker images' to view the newly built image in the local docker registry.
Code Block | ||||
---|---|---|---|---|
| ||||
$ docker images
onap/ccsdk-oran-a1policymanagementservice 1.0.3-SNAPSHOT
|
Build A1 Adapter for Controller
Build the code and create docker images
A1 Adapter is a feature developed within CCSDK which can then be installed in SDNC Karaf Server. To build & run the A1-enabled SDNC Controller, you need to build the ccsdk & sdnc repo's.
The Controller provides a Northbound Interface, to be used only by the A1 Policy Management Service, allowing it to pass messages over the A1 interface to Near-RealTime RICs in the RAN.
Use the downloaded repo 'ccsdk/oran' as in the previous step, "Build A1 Policy Management Service container"
Code Block | ||
---|---|---|
| ||
$ cd a1-adapter
$ mvn clean install -Dmaven.test.skip=true
$ docker images |
After you build the A1 adapter artefacts, download below CCSDK/SDNC repos and build them in the following order.
...
"name": "ric3",
"baseUrl": "http://ric3:8085/",
"controller": "controller1",
"managedElementIds": [
"kista_1",
"kista_2"
]
},
{
"name": "ric4",
"baseUrl": "http://ric4:8085/",
"controller": "controller1",
"managedElementIds": [
"kista_1",
"kista_2"
]
}
]
}
} |
Build the code and create docker image
To build docker image of the policy management service:
Code Block | ||
---|---|---|
| ||
$ cd oran/a1-policy-management/
$ mvn clean install -Dmaven.test.skip=true |
If the build is successful an image with following name and tag shall be built, use the command 'docker images' to view the newly built image in the local docker registry.
Code Block | ||||
---|---|---|---|---|
| ||||
$ docker images
onap/ccsdk-oran-a1policymanagementservice 1.1.2-SNAPSHOT
|
Build A1 Adapter for Controller
Build the code and create docker images
A1 Adapter is a feature developed within CCSDK which can then be installed in SDNC Karaf Server. To build & run the A1-enabled SDNC Controller, you need to build the ccsdk & sdnc repo's.
The Controller provides a Northbound Interface, to be used only by the A1 Policy Management Service, allowing it to pass messages over the A1 interface to Near-RealTime RICs in the RAN.
Use the downloaded repo 'ccsdk/oran' as in the previous step, "Build A1 Policy Management Service container"
Code Block | ||
---|---|---|
| ||
$ cd a1-adapter
$ mvn clean install -Dmaven.test.skip=true
$ docker images |
After you build the A1 adapter artefacts, download below CCSDK/SDNC repos and build them in the following order.
Project | Repo | Gerrit Link | Command | Note |
---|---|---|---|---|
CCSDK | ccsdk/parent | git clone "https://gerrit.onap.org/r/ccsdk/parent" -b honolulu | mvn clean install -Dmaven.test.skip=true | If the parent artefacts are not released you need to build this repo in order to build other ccsdk repos (Including ccsdk/oran/a1-adapter) |
CCSDK | ccsdk/feature | git clone "https://gerrit.onap.org/r/ccsdk/features" -b honolulu | mvn clean install -Dmaven.test.skip=true | |
CCSDK | ccsdk/distribution | git clone "https://gerrit.onap.org/r/ccsdk/distribution" -b honolulu | mvn clean install -Dmaven.test.skip=true -Pdocker | Creates the CCSDK docker image |
SDNC | sdnc/northbound | git clone "https://gerrit.onap.org/r/sdnc/northbound" -b honolulu | mvn clean install -Dmaven.test.skip=true | |
SDNC | sdnc/oam | git clone "https://gerrit.onap.org/r/sdnc/oam" -b honolulu | mvn clean install -Dmaven.test.skip=true -Pdocker | Creates the SDNC docker image. Make sure you refer the right docker image version in the pom file.(eg: you may need to update ccsdk.docker.version for onap/ccsdk-ansible-server-image from 1.0-STAGING-latest to 1.0-SNAPSHOT-latest) |
If the builds are successful, images with following name and tag shall exist, use the command 'docker images' to view the newly built images in the local docker registry.
Code Block | ||||
---|---|---|---|---|
| ||||
$ docker images | grep onap
onap/sdnc-image latest
onap/sdnc-ansible-server-image latest
onap/admportal-sdnc-image latest
onap/ccsdk-dgbuilder-image latest
onap/sdnc-ueb-listener-image latest
onap/sdnc-dmaap-listener-image:latest
|
Run A1-enabled Controller
To view the A1 policy operations, you need to run the SDNC docker image. This image has few other docker image dependencies but not all are important for A1 policy testing. To bring up the sdnc container for A1 Policy Management testing a number of the not needed services can be removed from the docker compose file.
Edit the docker compose file, oam/installation/src/main/yaml/docker-compose.yaml and keep only sdnc, maria db and ansible images. The rest of the images are not necessary for A1 Policy testing. However if you want to change the DG and run your own DG, you may need to keep the Directed Graph image.
Code Block | ||
---|---|---|
| ||
$ export MTU=1500
$ docker network create nonrtric-docker-net
$ cd oam/installation/src/main/yaml
$ docker-compose up
$ docker network connect nonrtric-docker-net sdnc_controller_container (use another shell) |
The SDNC image will take a while to install all the features into Karaf Server. You can check the logs of the server at /opt/opendaylight/data/log/karaf.log
The A1 Policy in ODL GUI can be accessed by this URL (it may take several minutes before the URL works)
http://localhost:8282/apidoc/explorer/index.html
Username/password: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
Run OSC Near-RT-RIC/A1 Simulator Docker Containers
Start docker containers for each ric defined in oran/a1-policy-management/config/application_configuration.json in the step for "Configuration Policy Management Service" (in this example for ric1 and ric2) and providing A1 interface version OSC_2.1.0 with the following commands (use separate shells):
Code Block language bash $ 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 nexus3.o-ran-sc.org:10002/o-ran-sc/a1-simulator:2.1.0 $ 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 nexus3.o-ran-sc.org:10002/o-ran-sc/a1-simulator:2.1.0 $ docker run -p 8087:8085 -p 8187:8185 -e A1_VERSION=STD_2.0.0 -e ALLOW_HTTP=true --network=nonrtric-docker-net --name=ric3 nexus3.o-ran-sc.org:10002/o-ran-sc/a1-simulator:2.1.0 $ docker run -p 8088:8085 -p 8188:8185 -e A1_VERSION=STD_2.0.0 -e ALLOW_HTTP=true --network=nonrtric-docker-net --name=ric4 nexus3.o-ran-sc.org:10002/o-ran-sc/a1-simulator:2.1.0
Create a policy type json to load into the A1 simulators (running version OSC.2.1.0)
Code Block language bash title pt1.json { "name": "pt1", "description": "pt1 policy type", "policy_type_id": 1, "create_schema": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "OSC_Type1_1.0.0", "description": "Type 1 policy type", "type": "object", "properties": { "scope": { "type": "object", "properties": { "ueId": { "type": "string" }, "qosId": { "type": "string" } }, "additionalProperties": false, "required": [ "ueId", "qosId" ] }, "qosObjectives": { "type": "object", "properties": { "priorityLevel": { "type": "number" } }, "additionalProperties": false, "required": [ "priorityLevel" ] } }, "additionalProperties": false, "required": [ "scope", "qosObjectives" ] } }
Put the example policy type into the started A1 simulator instances by running these curl commands (in this example to ric1 exposed to port 8085 and ric2 exposed to port 8086):
Code Block language bash $ curl -X PUT -v "http://localhost:8085/a1-p/policytypes/1" -H "accept: application/json" \ -H "Content-Type: application/json" --data-binary @pt1.json $ curl -X PUT -v "http://localhost:8086/a1-p/policytypes/1" -H "accept: application/json" \ -H "Content-Type: application/json" --data-binary @pt1.json
Create a policy type json to load into the A1 simulators (running version STD.2.0.0)
Code Block language bash title std_qos2_0.0.1.json { "policySchema": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "STD_QOS2_0.1.0", "description": "STD QOS2 policy type", "type": "object", "properties": { "scope": { "type": "object", "properties": { "ueId": { "type": "string" }, "qosId": { "type": "string" } }, "additionalProperties": false, "required": [ "ueId", "qosId" ] }, "qosObjectives": {
If the builds are successful, images with following name and tag shall exist, use the command 'docker images' to view the newly built images in the local docker registry.
Code Block | ||||
---|---|---|---|---|
| ||||
$ docker images | grep onap
onap/sdnc-image latest
onap/sdnc-ansible-server-image latest
onap/admportal-sdnc-image latest
onap/ccsdk-dgbuilder-image latest
onap/sdnc-ueb-listener-image latest
onap/sdnc-dmaap-listener-image:latest
|
Run A1-enabled Controller
To view the A1 policy operations, you need to run the SDNC docker image. This image has few other docker image dependencies but not all are important for A1 policy testing. To bring up the sdnc container for A1 Policy Management testing a number of the not needed services can be removed from the docker compose file.
Edit the docker compose file, oam/installation/src/main/yaml/docker-compose.yaml and keep only sdnc, maria db and ansible images. The rest of the images are not necessary for A1 Policy testing. However if you want to change the DG and run your own DG, you may need to keep the Directed Graph image.
Code Block | ||
---|---|---|
| ||
$ export MTU=1500
$ docker network create nonrtric-docker-net
$ cd oam/installation/src/main/yaml
$ docker-compose up
$ docker network connect nonrtric-docker-net sdnc_controller_container (use another shell) |
The SDNC image will take a while to install all the features into Karaf Server. You can check the logs of the server at /opt/opendaylight/data/log/karaf.log
The A1 Policy in ODL GUI can be accessed by this URL (it may take several minutes before the URL works)
http://localhost:8282/apidoc/explorer/index.html
Username/password: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
Run OSC Near-RT-RIC/A1 Simulator Docker Containers
Start docker containers for each ric defined in oran/a1-policy-management/config/application_configuration.json in the step for "Configuration Policy Management Service" (in this example for ric1 and ric2) and providing A1 interface version OSC_2.1.0 with the following commands (use separate shells):
Code Block language bash $ 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 nexus3.o-ran-sc.org:10002/o-ran-sc/a1-simulator:2.1.0 $ 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 nexus3.o-ran-sc.org:10002/o-ran-sc/a1-simulator:2.1.0
Create a policy type json to load into the A1 simulators
Code Block language bash title pt1.json { "name": "pt1", "description": "pt1 policy type", "policy_type_id": 1, "create_schema": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "OSC_Type1_1.0.0", "description": "Type 1 policy type", "type": "object", "properties": { "scope": { "type": "object", "properties": { "ueIdpriorityLevel": { "type": "string"number" } }, "qosIdadditionalProperties": {false, "typerequired": [ "stringpriorityLevel" }] }, } "additionalProperties": false}, "requiredstatusSchema": [{ "ueId"$schema": "http://json-schema.org/draft-07/schema#", "qosId""title": "STD_QOS_0.2.0", "description": "STD ] QOS policy }type status", "qosObjectivestype": {"object", "typeproperties": "object",{ "propertiesenforceStatus": { "priorityLeveltype": { "string" }, "typeenforceReason": "number"{ }"type": "string" }, "additionalProperties": false, "required": [ "priorityLevelenforceStatus" ] } }, "additionalProperties": false, "required": [ "scope", "qosObjectives" ] } } }
Put the example policy type into the started A1 simulator instances by running these curl commands (in this example to ric3 exposed to port 8087 and ric4 exposed to port 8088):
Code Block language bash $ curl -X PUT -v "http://localhost:8087/policytype?id=STD_QOS2_0.1.0" -H "accept: application/json" \ -H "Content-Type: application/json" --data-binary @std_qos2_0.0.1.json
Put the example policy type into the started A1 simulator instances by running these curl commands (in this example to ric1 exposed to port 8085 and ric2 exposed to port 8086):
Code Block language bash $ curl -X PUT -v "http://localhost:8085/a1-p/policytypes/1" 8088/policytype?id=STD_QOS2_0.1.0" -H "accept: application/json" \ -H "acceptContent-Type: application/json" \ -H "Content-Type: application/json" --data-binary @pt1.json $ curl -X PUT -v "http://localhost:8086/a1-p/policytypes/1" -H "accept: application/json" \ -H "Content-Type: application/json" --data-binary @pt1.json
Run ONAP A1 Policy Management Service Docker Container
--data-binary @std_qos2_0.0.1.json
Run ONAP A1 Policy Management Service Docker Container
Run docker container using this command once the A1-enabled Controller and simulators have been fully started and optionally set the logging level to trace (the curl command will not work until the container is fully up and running).
The configuration, application_configuration.json, of the controller and rics must be mounted as a volume to the container.
Run docker container using this command once the A1-enabled Controller and simulators have been fully started and optionally set the logging level to trace (the curl command will not work until the container is fully up and running).Code Block language bash $ docker run -p 8081:8081 --network=nonrtric-docker-net --name=policy-agent-container --volume <Absolute path to application_configuration.json created above>:/opt/app/policy-agent/data/application_configuration.json onap/ccsdk-oran-a1policymanagementservice:1.1.2-SNAPSHOT
The configuration, application_configuration.json, of the controller and rics must be mounted as a volume to the container.Code Block language bash $ dockercurl run-X -p 8081:8081 --network=nonrtric-docker-net --name=policy-agent-container --volume <Absolute path to application_configuration.json created above>:/opt/app/policy-agent/data/application_configuration.json onap/ccsdk-oran-a1policymanagementservice:1.0.3-SNAPSHOTPOST http://localhost:8081/actuator/loggers/org.onap.ccsdk.oran.a1policymanagementservice -H "Content-Type:application/json" -d {\"configuredLevel\":\"trace\"}
Once the Policy Management Service is up and running, it establishes connections to all configured Near-RT RICs (ric1 and ric2) via the A1 Controller.
If the policy-agent-container is configured to log at trace level, the following logs entries should appear indicating that connection to the configured RICs has been established successfully via A1 Controller.
Code Block | ||
---|---|---|
| ||
$ docker |
...
logs |
...
Once the Policy Management Service is up and running, it establishes connections to all configured Near-RT RICs (ric1 and ric2) via the A1 Controller.
...
If the policy-agent-container is configured to log at trace level, the following logs entries should appear indicating that connection to the configured RICs has been established successfully via A1 Controller.
Code Block | ||
---|---|---|
| ||
$ docker logs policy-management-service | grep "protocol version" 2020-11-23 16:00:27.484policy-management-service | grep "checked" 2021-03-16 14:15:03.805 DEBUG 1 --- [or-http-epoll-5] o.o.c.o.a.tasks.RicSupervision : Ric: ric1 checked OK 2021-03-16 14:15:03.816 DEBUG 1 --- [or-http-epoll-6] o.o.c.o.a.tasks.RicSupervision : Ric: ric3 checked OK 2021-03-16 14:15:03.835 DEBUG 1 --- [or-http-epoll-51] o.o.c.o.a.clientstasks.A1ClientFactoryRicSupervision : Established protocol version:SDNC_OSC_OSC_V1 for Near-RT RIC: ric1 2020-11-23 16:00:27.495 Ric: ric2 checked OK 2021-03-16 14:15:03.851 DEBUG 1 --- [or-http-epoll-62] o.o.c.o.a.clientstasks.A1ClientFactoryRicSupervision : Established protocol version:SDNC_OSC_OSC_V1 for Near-RT RIC: ric2 Ric: ric4 checked OK |
A1 Policy Management Service Swagger API
For troubleshooting/verification purposes you can view/access the policy-agent swagger API from url: http://localhost:8081/swagger-ui.html
Run OSC Non-RT RIC Control Panel Docker Container
Run docker container using this command:
Code Block | ||
---|---|---|
| ||
$ docker run -p 8080:8080 --network=nonrtric-docker-net nexus3.o-ran-sc.org:10002/o-ran-sc/nonrtric-controlpanel:2.1.0 |
Open NONRTRIC / A1 Policy Control Panel UI
The Control Panel UI can be accessed by pointing the web-browser to this URL:
...