Merge "A bit of documentation for nearRT RIC simulator"

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 43c3d25..5177088 100644 (file)
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -71,7 +71,7 @@ See the following document for the Policy Agent API: nonrtric/policy-agent/docs/
 
 Near-RT RIC Simulator
 =====================
-A simulator that simulates a Neat-RT RIC, with a termination of the A1 interface. It also provides an administrative API to manage types and instances so it can be programatically set up for use in tests.
+A simulator that simulates a Near-RT RIC, with a termination of the A1 interface. It also provides an administrative API to manage types and instances so it can be programatically set up for use in tests.
 
 See the README.md file in the nonrtric/near-rt-ric-simulator repo for info about how to use it.
 

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index aea9f07..0b98cc5 100644 (file)
--- 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,22 @@ 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 through the DMaaP Interface. The REST API is documented in the *nonrtric/policy-agent/docs/api.yaml* file. Please Refer README file of PolicyAgent to know more about the API's.
+
+
 Near-RT RIC Simulator Developer Guide
 =====================================
 
@@ -71,4 +83,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 3f421d3..d33d2f9 100644 (file)
--- 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/docs/release-notes.rst b/docs/release-notes.rst
index 14a2490..e4cbc8b 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,20 +1,20 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-
+=============
 Release-Notes
 =============
 
 
-This document provides the release notes for Amber release of Non-RT RIC.
+This document provides the release notes for the release of the different parts of the Non-RT RIC.
 
 .. contents::
    :depth: 3
    :local:
 
 
-Version history
----------------
+Version history Dashboard
+=========================
 
 +--------------------+--------------------+--------------------+--------------------+
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
@@ -29,7 +29,9 @@ Version history
 |                    | 1.0                |                    |                    |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-
+| 2020-02-03         | 1.1                | Henrik Andersson   | Amber Maintenance  |
+|                    |                    |                    | Release            |
++--------------------+--------------------+--------------------+--------------------+
 
 Summary
 -------
@@ -40,26 +42,97 @@ The Non-RT RIC is not yet fully compliant with the A1 specifications for this re
 
 .. _here: a1_policy_procedure
 
+Version history Policy Agent
+============================
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-02-03         | 1.0.0              | Henrik Andersson   | First version      |
+|                    |                    |                    | Amber Maintenance  |
+|                    |                    |                    | Release            |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Version history Near-RT RIC Simulator
+=====================================
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2019-11-12         | 0.1.0              | Maxime Bonneau     | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 0.1.1              |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+|                    | 1.0                |                    |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-02-03         | 1.1                | Henrik Andersson   | Amber Maintenance  |
+|                    |                    |                    | Release            |
++--------------------+--------------------+--------------------+--------------------+
+
+Summary
+-------
+First version with support for R-apps to register and send A1 commands to Near-RT RICs.
+
+
+Version history SDNC A1 Controller
+==================================
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2019-11-12         | 1.7.3              | Maxime Bonneau     |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-02-03         | 1.7.4              | Henrik Andersson   | Amber Maintenance  |
+|                    |                    |                    | Release            |
++--------------------+--------------------+--------------------+--------------------+
+
 
 Release Data
-------------
+============
 
+Amber
+-----
 +--------------------------------------+--------------------------------------+
-| **Project**                          | Non-RT RIC                          |
+| **Project**                          | Non-RT RIC                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/commit-ID**                   | TBC                                  |
+| **Repo/commit-ID**                   | nonrtric/ec382949                    |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | **Release designation**              | Amber                                |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | 2019-XX-XX                           |
+| **Release date**                     | 2019-11-22                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Introducing Non-RT RIC              |
+| **Purpose of the delivery**          | Introducing Non-RT RIC               |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-
+Amber Maintenance
+-----------------
++--------------------------------------+--------------------------------------+
+| **Project**                          | Non-RT RIC                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   | nonrtric/                            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | Amber Maintenance Release            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2020-02-03                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | Introducing Policy Agent and         |
+|                                      | updating to latest A1 spec           |
++--------------------------------------+--------------------------------------+
 

diff --git a/policy-agent/README.md b/policy-agent/README.md
index 655000e..bbd6fcc 100644 (file)
--- 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.