From e1041aa30c4792d3b85d78e7b32d19f066eb5218 Mon Sep 17 00:00:00 2001 From: Lathish Date: Fri, 31 Jan 2020 14:01:45 +0000 Subject: [PATCH 1/1] Updated the documentation NONRTRIC-111 Change-Id: I0d5f6187ba802018459a4f7989c607a4501f4257 Signed-off-by: Lathish --- docs/developer-guide.rst | 12 +++++++----- docs/index.rst | 2 +- policy-agent/README.md | 25 +++++++++++++++++++++++++ 3 files changed, 33 insertions(+), 6 deletions(-) diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index aea9f07c..e4c3d8f5 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,10 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -A1 Mediation: -1. SDNC Controller -2. Near-RT RIC Simulator - SDNC A1 Controller Developer Guide ================================== @@ -43,6 +39,12 @@ The SDNC url to access the Northbound API, Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U +Policy Agent +===================================== +The O-RAN NonRT 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. +The PolicyAgent can be accessed over the REST API or throught DMaaP Interface. Please Refer README file of PolicyAgent to know more about the API's. + + Near-RT RIC Simulator Developer Guide ===================================== @@ -71,4 +73,4 @@ End-to-end call In order to make a complete end-to-end call, follow the instructions given in this `guide`_. -.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166 \ No newline at end of file +.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166 diff --git a/docs/index.rst b/docs/index.rst index 3f421d33..d33d2f9b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,4 +20,4 @@ Non-RT RIC * :ref:`genindex` * :ref:`modindex` -* :ref:`search` \ No newline at end of file +* :ref:`search` diff --git a/policy-agent/README.md b/policy-agent/README.md index 655000ec..bbd6fcce 100644 --- a/policy-agent/README.md +++ b/policy-agent/README.md @@ -26,6 +26,31 @@ mvn -Dtest=MockPolicyAgent test The backend server publishes live API documentation at the 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 Copyright (C) 2019 Nordix Foundation. All rights reserved. -- 2.16.6