-# O-RAN-SC NonRT RIC Dashboard Web Application
-
-The O-RAN NonRT RIC PolicyAgent provides a REST API for management of
-policices. It provides support for
--Policy configuration. This includes
- -One REST API towards all RICs in the network
- -Query functions that can find all policies in a RIC, all policies owned by a service (R-APP), all policies of a type etc.
- -Maps O1 resources (ManagedElement) as defined in O1 to the controlling RIC
--Supervision of clients (R-APPs) to eliminate stray policies in case of failure
--Consistency monitoring of the SMO view of policies and the actual situation in the RICs
--Consistency monitoring of RIC capabilities (policy types)
+# O-RAN-SC Non-RT RIC Policy Agent
+
+The O-RAN Non-RT RIC PolicyAgent provides a REST API for management of policices.
+It provides support for:
+ -Supervision of clients (R-APPs) to eliminate stray policies in case of failure
+ -Consistency monitoring of the SMO view of policies and the actual situation in the RICs
+ -Consistency monitoring of RIC capabilities (policy types)
+ -Policy configuration. This includes:
+ -One REST API towards all RICs in the network
+ -Query functions that can find all policies in a RIC, all policies owned by a service (R-APP),
+ all policies of a type etc.
+ -Maps O1 resources (ManagedElement) as defined in O1 to the controlling RIC
To Run Policy Agent in Local:
-Create a symbolic link with below command,
+In the folder /opt/app/policy-agent/config/, create a soft link with below command,
ln -s <path to test_application_configuration.json> application_configuration.json
-The agent can be run stand alone in a simulated test mode. Then it
-simulates RICs.
+To Run Policy Agent in Local with the DMaaP polling turned on:
+In the folder /opt/app/policy-agent/config/, create a soft link with below command,
+ln -s <path to test_application_configuration_with_dmaap_config.json> application_configuration.json
+
+The agent can be run stand alone in a simulated test mode. Then it simulates RICs.
The REST API is published on port 8081 and it is started by command:
mvn -Dtest=MockPolicyAgent test
The backend server publishes live API documentation at the
-URL `http://your-host-name-here:8080/swagger-ui.html`
+URL `http://your-host-name-here:8081/swagger-ui.html`
+
+PolicyAgent uses A1-POLICY-AGENT-READ & A1-POLICY-AGENT-WRITE topic for subscribe & Publish to the DMaap.
+Sample Request Message to DMaaP:
+{
+ "type": "request",
+ "target": "policy-agent",
+ "timestamp": "2019-05-14T11:44:51.36Z",
+ "operation": "GET",
+ "correlationId": "c09ac7d1-de62-0016-2000-e63701125557-201",
+ "apiVersion": "1.0",
+ "originatorId": "849e6c6b420",
+ "requestId": "23343221",
+ "url": "/policies?type=type1&ric=ric1&service=service1"
+}
+
+Sample Response Message to DMaaP:
+{
+ "type": "response",
+ "timestamp": "2019-05-14T11:44:51.36Z",
+ "correlationId": "c09ac7d1-de62-0016-2000-e63701125557-201",
+ "originatorId": "849e6c6b420",
+ "requestId": "23343221",
+ "status": "200 OK",
+ "message": []
+}
## License