Page Comparison

This page describes how to get the Jakarta New-Delhi release version of A1-Policy functions up and running using Docker.

The A1 Policy Management Service and the (optional) A1-enabled Controller (SDNC with A1-Adapter) will run in a local demonstrative deployment with four near-RT-RIC A1 simulator instances (docker containers). These simulators will be configured to emulate devices implementing either the "OSC_2.1.0" version or "STD_2.0.0" version of the O-RAN A1 interface. (For more information on the OSC A1 Simulator functions see OSC NONRTRIC Wiki page (Release J)

All components run as docker containers and communicate via a private docker network. Details of the architecture can be found from New Delhi Release page.

...

• Copy the default configuration file oran/a1-policy-management/config/application_configuration.json (newdelhi) to the current directory, then replace/amend the configuration with the sample demo configuration below.
  (Note the configuration below is just a sample, and should be updated to match particular deployments.  The deployment below assumes 4 near-RT-RICs exist - addressable at the URLs given. See the step "Run OSC Near-RT-RIC/A1 Simulator Docker Containers" below)

• The controller URL (hostname, port), username and password values to access the A1 Controller (SDNC + A1 Adapter) must match the values configured for the SDNC-A1-Controller. (See the step "Run A1 Controller" further below). The port number for http here is 8181.
  (Note the configuration below is just a sample, and should be updated to match particular deployments.  The deployment below assumes an A1 Controller function (SDNC) exists - addressable at the url given, using the authentication credentials given.)

• Any defined ric host names (in the name and baseUrl for each ric entry) must match the given docker container names in near-RT-RIC simulator startup - . Here the port is always the simulator's internal port 8085 for http or 8185 for https.

• The A1 Policy Management service can entirely by-pass the A1-Controller (SDNC + A1 Adapter) if desired - it is optional to access the near-RT-RIC through an A1-Controller/SDNC.
  

  Info
  title Alternative: Bypass the A1-Controller - connect direct from A1-Policy Management Service
  There is no functional gain in accessing the near-RT-RIC through an A1-Controller. To bypass the  A1-Controller (SDNC + A1 Adapter), where the A1-Policy Management Service connects directly to the A1 Interface: In the configuration the "controller" property is optional in the "ric" objects If all configured rics bypass the A1-Controller (do not have "controller" values) then the "controller" object at the top of the configuration can be omitted. If all configured rics bypass the A1-Controller there is no need to start an A1-Controller.

  
  

...

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

      {
        "name": "ric3",
        "baseUrl": "http://ric3:8085/",
            "managedElementIds": [
          "kista_5",
          "kista_6"
        ]
      },

      {
        "name": "ric4",
        "baseUrl": "http://ric4:8085/",
           "managedElementIds": [
          "kista_7",
          "kista_8",
          "kista_9",
          "kista_10",
          "kista_11"
            ]
      }
    ]
  }
}

JSON Schema for the application configuration

The configuration must comply to the following JSON schema. There are several publicly available tools (e.g. online) where it is possible to validate JSON objects against their schema. 
The schema is available in the gerrit repo (application_configuration_schema.json (newdelhi))

...

Run A1-enabled Controller

...

• Start docker containers for each near-RT-RIC defined in oran/a1-policy-management/config/application_configuration.json in the step "Configure the A1 Policy Management Service" above.
  Different Simulators can use different A1-Interface profiles, for example OSC_2.1.0 and STD_2.0.0 below. Start each simulator instance with the following commands (use separate shells):

  Code Block

  (Each in a new shell) 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.67.10 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.67.10 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.67.10 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.67.10

  • (Note these commands create a deployment scenario aligned towards the sample A1 Policy configuration given above)
    (Note these commands can be run in the background - all in one shell - by using docker run -d -p ..... )

  For the OSC.2.1.0 simulators create a new A1 Policy Type policy type definition (JSON), and load it into each of the OSC.2.1.0 A1 Simulators instances.
  (Note the format for A1 Policy Type Definitions (JSON) differs for different A1-Interface profiles)
  

  Code Block

  language	js
  title	pt1.json
  collapse	true

  { "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": [

  • These commands start 4 simulator instances ("ric1", "ric2", "ric3", "ric4"), with REST endpoints at ports 8085 and 8185.
    Other docker containers using the same docker network ("nonrtric-docker-net") can address containers by name, and directly access those REST endpoints. e.g.:

    • (ric1) → ric1:8085 & ric1:8185
    • (ric2) → ric2:8085 & ric2:8185
    • (ric3) → ric3:8085 & ric3:8185
    • (ric4) → ric4:8085 & ric4:8185
  • Ports 8085 & 8185 are also exposed outside the network for all 4 simulator instances.
    These ports are mapped to local ports on the host, corresponding to:
    • Port 8085 on ric1 →localhost:8085  and   Port 8085 on ric1 →localhost:8185
    • Port 8085 on ric2 →localhost:8086  and   Port 8185 on ric2 →localhost:8186
    • Port 8085 on ric3 →localhost:8087  and   Port 8185 on ric3 →localhost:8187
    • Port 8085 on ric4 →localhost:8088  and   Port 8185 on ric4 →localhost:8188

• For the OSC.2.1.0 simulators create a new A1 Policy Type policy type definition (JSON), and load it into each of the OSC.2.1.0 A1 Simulators instances. (policy_type_id = 1)
  (Note the format for A1 Policy Type Definitions (JSON) differs for different A1-Interface profiles)
  

  Code Block
  language js title pt1.json collapse true
  { "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",: "qosObjectives"{ ] } }

  Insert the example policy type into the started OSC_2.1.0 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

  For the STD_2.0.0 simulators create a new A1 Policy Type policy type definition (JSON), and load it into each of the STD_2.0.0A1 Simulators instances.
  (Note the format for A1 Policy Type Definitions (JSON) differs for different A1-Interface profiles)

  Code Block
  language js title std_qos2_0.0.1.json collapse true
  { "policySchema": { "type": "object", "properties": { "ueId": { "type": "string" }, "qosId": { "$schematype": "http://json-schema.org/draft-07/schema#",string" "title": "STD_QOS2_0.1.0", } "description": "STD QOS2 policy type"}, "typeadditionalProperties": "object"false, "propertiesrequired": {[ "scopeueId": {, "typeqosId": "object", ] "properties": { }, "ueIdqosObjectives": { "type": "stringobject", "properties": { }, "qosIdpriorityLevel": { "type": "stringnumber" } }, "additionalProperties": false, "required": [ "ueIdpriorityLevel", ] "qosId" } ] }, "qosObjectivesadditionalProperties": {false, "type"required": "object", [ "properties": { "priorityLevel": {scope", "qosObjectives" ] "type": "number" } }, "additionalProperties": false, "required": [} }

  • Insert the example policy type into the started OSC_2.1.0 A1 Simulator instances by running these curl commands (in this example to ric1 exposed to port localhost:8085 and ric2 exposed to port localhost:8086 as described above):

    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

    
    

• For the STD_2.0.0 simulators create a new A1 Policy Type policy type definition (JSON), and load it into each of the STD_2.0.0A1 Simulators instances. (policy_type_id = "STD_QOS2_0.1.0")
(Note the format for A1 Policy Type Definitions (JSON) differs for different A1-Interface profiles)

  Code Block
  language js title std_qos2_0.0.1.json collapse true
  { "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" ] } } }

  


  • Insert the example policy type into the started STD_2.0.0 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 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

    


For more details about running the OSC A1 Simulator see the related OSC NONRTRIC Wiki page (Release J) and OSC A1 Simulator Documentation (J Release)

Run ONAP A1 Policy Management Service Docker Container

• Run A1 Policy Management Service docker container using the command below, after the A1-Controller and simulators have been fully started.
The configuration file (application_configuration.json described above) must be mounted as a volume into the container, so absolute path and name of the file must be substituted in the following command:

  Code Block
  language bash title Docker: Run the A1 Policy Management Service
  docker run -p 8081:8081 --network=nonrtric-docker-net --name=a1policymanagmentservice --volume **<Absolute path to application_configuration.json created above>**:/opt/app/policy-agent/data/application_configuration.json nexus3.onap.org:10002/onap/ccsdk-oran-a1policymanagementservice:1.7.1

  Note: Version numbers used in this page may not be the most recent ... you should verify the latest version numbers for released pre-built components in the docker image repository (https://nexus3.onap.org)
Note: Make sure to give the full/absolute path to the configuration file. Docker will need this full path to find the file to mount it as a volume. Otherwise Docker will instead create an empty directory as the volume inside the container. 


  • This command starts the A1 Policy Management Service, using the configuration specified above, with its REST endpoint available at ports 8081
Other docker containers using the same docker network ("nonrtric-docker-net") can address this container by name, and directly access its REST endpoints. i.e.:
a1policymanagmentservice:8081

  • Ports 8081 is also exposed outside the network , mapped to a local port on the host. i.e.:
Port 8081 in a1policymanagmentservice container →localhost:8081


• It may be useful to set the logging level to TRACE level, where you can verify the A1-Controller, A1-Simualtors and A1 Policy Management Service is fully up and running.
  

  
  

  Code Block
  language bash title Optional: Enable TRACE level logging in A1 Policy Management Service collapse true
  curl -i -X POST "http://localhost:8081/actuator/loggers/org.onap.ccsdk.oran.a1policymanagementservice" -H "Content-Type:application/json" -d {\"configuredLevel\":\"trace\"} curl -i -X GET "http://localhost:8081/actuator/loggers/org.onap.ccsdk.oran.a1policymanagementservice"

  
  

• Once the Policy Management Service is up and running, it establishes connections to all configured near-RT-RICs (ric1, ric2, ric3, ric4) via the A1 Controller.

• If the a1policymanagmentservice container is configured to log at TRACE level, the following logs entries should appear indicating that connection to the configured near-RT-RICs has been established successfully (via A1 Controller if enabled).

docker logs a1policymanagmentservice  | grep "checked" 
	2024-03-16 14:15:03.805 DEBUG 1 --- [or-http-epoll-5] o.o.c.o.a.tasks.RicSupervision           : Ric: ric1 checked OK
	2024-03-16 14:15:03.816 DEBUG 1 --- [or-http-epoll-6] o.o.c.o.a.tasks.RicSupervision           : Ric: ric3 checked OK
	2024-03-16 14:15:03.835 DEBUG 1 --- [or-http-epoll-1] o.o.c.o.a.tasks.RicSupervision           : Ric: ric2 checked OK
	2022-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 A1 Policy Management Service swagger API from url: http://localhost:8081/swagger-ui.html  
Note: the hostname may be different depending on your environment, port 8081 is configured in the docker command above


Check A1-Policy types and Status of the simulated near-RT-RICs

Allow 1 minute for the A1-Policy Management Service to correctly synchronize with the simulated near-RT-RICs (e.g. automatically identify which A1-Policy Types are supported in the "ric").

• A1-Policy Management Service - Check “rics”
https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/offeredapis/pms-api.html#operation/getRics

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

  


• A1-Policy Management Service - Get Policy Types
https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/offeredapis/pms-api.html#operation/getPolicyTypes

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

  


• A1-Policy Management Service - Get Policy Type details
https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/offeredapis/pms-api.html#operation/getPolicyType

  Code Block

  curl localhost:8081/a1-policy/v2/policy-types/1 "priorityLevel" # For A1 Policy Type 1 described above ] curl localhost:8081/a1-policy/v2/policy-types/STD_QOS2_0.1.0 }# For A1 Policy Type “STD_QOS2_0.1.0” } }, "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" ] } } }

  Insert the example policy type into the started STD_2.0.0 A1 Simulator instances by running these curl commands (in this example to ric3 exposed to port 8087 and ric4 exposed to port 8088):

  described above

  
  

Create some A1-Policy instances using CURL


The deployments above contains 4 near-RT-RICs ("ric1", "ric2", "ric3", "ric4"), accessible via the deployed A1-Policy Management Service.


A1-Policy Type “STD_QOS2_0.1.0” is supported in 2 simulators ("ric3", "ric4"), and A1-Policy Type 1 is supported in 2 simulators ("ric1", "ric2").

• Sample A1-Policy Instance data that corresponds to A1-Policy Type “STD_QOS2_0.1.0” is shown below. This can be used to create a new A1-Policy instance on "ric3" or "ric4".

  Code Block
  language js title Instance#1: policy_data payload: Type: "STD_QOS2_0.1.0"
  {     "scope": {         "ueId": "ue5000",         "qosId": "qos5000"     },     "qosObjectives": {         "priorityLevel": 5000     }}

  


  • The payload to create a new A1-Policy Instance () of type “STD_QOS2_0.1.0” on "ric3" is shown below


    Code Block
    language js title Instance#1: instance_1.json
    {     "ric_id": "ric3",     "policy_id": "aa8feaa88d",     "service_id": "myapp",     "policytype_id": "STD_QOS2_0.1.0",     "policy_data": {         "scope": {             "ueId": "ue5000",             "qosId": "qos5000"         },         "qosObjectives": {             "priorityLevel": 5000         }     } }

    


  • https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/offeredapis/pms-api.html#tag/A1-Policy-Management/operation/putPolicy

    Code Block
    language bash
    curl -X PUT -v "http://localhost:8087/policytype?id=STD_QOS2_0.1.08081/a1-p/policies" -H "accept: application/json" \ -H "Content-Type: application/json" --data-binary @std_qos2_0.0.@instance_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

For more details about running the OSC A1 Simulator see the related OSC NONRTRIC Wiki page (Release J) and OSC A1 Simulator Documentation (I Release)

Run ONAP A1 Policy Management Service Docker Container

Run A1 Policy Management Service docker container using the command below, after the A1-Controller and simulators have been fully started.
It may be useful to set the logging level to TRACE level, where you can verify the A1-Controller, A1-Simualtors and A1 Policy Management Service is fully up and running.
The configuration file (application_configuration.json described above) must be mounted as a volume into the container, so absolute path and name of the file must be substituted in the following command:

docker run -p 8081:8081 --network=nonrtric-docker-net --name=a1policymanagmentservice --volume **<Absolute path to application_configuration.json created above>**:/opt/app/policy-agent/data/application_configuration.json nexus3.onap.org:10002/onap/ccsdk-oran-a1policymanagementservice:1.7.0

Note: Version numbers used in this page may not be the most recent ... you should verify the latest version numbers for released pre-built components in the docker image repository (https://nexus3.onap.org)

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, ric2, ric3, ric4) via the A1 Controller.

...

If the a1policymanagmentservice 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.

docker logs a1policymanagmentservice  | grep "checked" 
	2022-03-16 14:15:03.805 DEBUG 1 --- [or-http-epoll-5] o.o.c.o.a.tasks.RicSupervision           : Ric: ric1 checked OK
	2022-03-16 14:15:03.816 DEBUG 1 --- [or-http-epoll-6] o.o.c.o.a.tasks.RicSupervision           : Ric: ric3 checked OK
	2022-03-16 14:15:03.835 DEBUG 1 --- [or-http-epoll-1] o.o.c.o.a.tasks.RicSupervision           : Ric: ric2 checked OK
	2022-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

...

• • 8081/a1-p/policies"       Result:        {"policy_ids":["aa8feaa88d"]}curl "localhost:8081/a1-policy/v2/policies/aa8feaa88d944d919ef0e83f2172a5000"       Result:        {"ric_id":"ric3","policy_id":"aa8feaa88d944d919ef0e83f2172a5000","service_id":"controlpanel","policy_data":{"scope":{"ueId":"ue5000","qosId":"qos5000"},"qosObjectives":{"priorityLevel":5000}},"status_notification_uri":null, "policytype_id":"STD_QOS2_0.1.0","transient":false}

    



• Sample A1-Policy Instance data that corresponds to A1-Policy Type 1 is shown below. This can be used to create a new A1-Policy instance on "ric1" or "ric2".

  Code Block
  language js title Instance#2: policy_data payload: Type: 1
  {     "scope": {         "ueId": "ue6000",         "qosId": "qos6000"     },     "qosObjectives": {         "priorityLevel": 6000     }}

  


  • The payload to create a new A1-Policy Instance () of type “STD_QOS2_0.1.0” on "ric2" is shown below


    Code Block
    language js title Instance#2: instance_2.json
    {     "ric_id": "ric2",     "policy_id": "172a5100",     "service_id": "myapp",     "policytype_id": "1",     "policy_data": {         "scope": {             "ueId": "ue6000",             "qosId": "qos6000"         },         "qosObjectives": {             "priorityLevel": 6000         }     } }

    


  • https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/offeredapis/pms-api.html#tag/A1-Policy-Management/operation/putPolicy

    Code Block
    language bash
    curl -X PUT -v "http://localhost:8081/a1-p/policies" -H "accept: application/json" -H "Content-Type: application/json" --data-binary @instance_2.json curl "http://localhost:8081/a1-p/policies"       Result:       {"policy_ids":["172a5000", "aa8feaa88d"]}curl "localhost:8081/a1-policy/v2/policies/172a5000"      Result:       {"ric_id":"ric2","policy_id":"172a5000","service_id":"myapp","policy_data":{"scope":{"ueId":"ue6000","qosId":"qos6000"},"qosObjectives":{"priorityLevel":6000}},"status_notification_uri":null,"policytype_id":"1","transient":false}

    


Run OSC Non-RT RIC Control Panel Docker Container

...

The Control Panel UI can be accessed by pointing the web-browser to this URL: http://localhost:8080/ (or) http://<yourclusterloginip>:8080/
Note: the hostname may be different depending on your environment. The port number is defined using the docker command above.

...