DRAFT
This page describes how to get and build the Istanbul 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 Istanbul 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
However, pre-built versions are available to download, so re-building is not necessary for the majority of users - and should only be attempted by experienced ONAP developers.
For more information on running the pre-built and tested versions see Istanbul - Run
Table of Contents |
---|
Project Requirements
Java 11 JDK (make sure that JAVA_HOME environment variable points to correct Java version)
Maven 3.6
Docker and docker-compose (latest)
Build Code
- Note 1: While instructions to build the artifacts are included below, pre-built versions are available as Docker Images in http://nexus3.onap.org
- Building the code should only be attempted if you really need to, or wish in incorporate some change; it is much easier to use the pre-built versions.
- Note 2: Before attempting to retrieve or build any ONAP component please follow the instructions for Setting Up Your Development Environment
- Note 3: After re-building run the functions by following instructions at Istanbul - Run - but note the version numbers of the newly-built functions may be slightly different from the pre-built versions.
Build A1 Policy Management Service container
Download the ccsdk/oran repo, iItanbul Istanbul branch:
Code Block language bash $ git clone "https://gerrit.onap.org/r/ccsdk/oran" -b istanbul
Configure the A1 Policy Management Service
To support local test with two separate Near-RT RIC simulator instances:
- Copy the file oran/a1-policy-management/config/application_configuration.json to the current directory and update it with the configuration below.
The controller hostname and port values come from and must match those defined in in the sdnc/oam repo oam/installation/src/main/yaml/docker-compose.yml (see the step "
Build
...
the
...
code
...
language | yml |
---|---|
title | application_configuration.json |
...
{
"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": "controller1",
"managedElementIds": [
"kista_1",
"kista_2"
]
},
{
"name": "ric2",
"baseUrl": "http://ric2:8085/",
"controller": "controller1",
"managedElementIds": [
"kista_3",
"kista_4"
]
},
{
"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"
]
}
]
}
}
...
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.12.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 CCSDK & sdnc 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 Nearnear-RT-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 artefactsartifacts, 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 istanbul | mvn clean install -Dmaven.test.skip=true | If the parent artefacts artifacts are not released you need to build this repo in order to build other ccsdk repos (Including ccsdk/oran/a1-adapter) |
CCSDK | ccsdk/featurefeatures | git clone "https://gerrit.onap.org/r/ccsdk/features" -b istanbul | mvn clean install -Dmaven.test.skip=true | |
CCSDK | ccsdk/distribution | git clone "https://gerrit.onap.org/r/ccsdk/distribution" -b istanbul | 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 istanbul | mvn clean install -Dmaven.test.skip=true | |
SDNC | sdnc/oam | git clone "https://gerrit.onap.org/r/sdnc/oam" -b istanbul | 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 ccsdkupdate ccsdk.docker.version for onap/ccsdk-ansible-server-image from 1.02-STAGING-latest to 1.02-SNAPSHOT-latest) |
Note: full re-builds of the CCSDK and SDNC projects are prone to errors - cloned functions may require manual tweaking to be successful. It is usually better to use pre-built and tested images.
If your build is unsuccessful more help can be found from the CCSDK/SDNC Developer teams: CCSDK Project & SDNC Project
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 | ||
---|---|---|
| ||
$ 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 | ||||
---|---|---|---|---|
| ||||
{
"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 | ||
---|---|---|
| ||
$ 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 | ||||
---|---|---|---|---|
| ||||
{
"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": {
"type": "object",
"properties": {
"priorityLevel": {
"type": "number"
}
},
"additionalProperties": false,
"required": [
"priorityLevel"
]
}
}
},
"statusSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "STD_QOS_0.2.0",
"description": "STD QOS policy type status",
"type": "object",
"properties": {
"enforceStatus": {
"type": "string"
},
"enforceReason": {
"type": "string"
},
"additionalProperties": false,
"required": [
"enforceStatus"
]
}
}
} |
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 | ||
---|---|---|
| ||
$ 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
$ curl -X PUT -v "http://localhost:8088/policytype?id=STD_QOS2_0.1.0" -H "accept: application/json" \
-H "Content-Type: application/json" --data-binary @std_qos2_0.0.1.json |
Proxy support for A1 adapter
There is the possibility to use a proxy when CCSDK SLI node function to perform REST calls southbound to near-RT-RICs.
In order to configure proxy:
- Add proxy URL to properties file odlsli/src/main/properties/a1-adapter-api-dg.properties variable a1Mediator.proxy.url
- This file is part of CCSDK/distribution project
- After adding this information in the file, the distribution repo from CCSDK must be rebuilt, follow by the SDNC/oam repo.
- URL format must be protocol://host:port for example http://proxy:8443
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.
Code Block | ||
---|---|---|
| ||
$ 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 |
Code Block | ||
---|---|---|
| ||
$ curl -X POST 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 policy-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-1] o.o.c.o.a.tasks.RicSupervision : Ric: ric2 checked OK
2021-03-16 14:15:03.851 DEBUG 1 --- [or-http-epoll-2] o.o.c.o.a.tasks.RicSupervision : 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:
...