Merge "Minor changes"
[nonrtric.git] / docs / developer-guide.rst
index 0b98cc5..5402328 100644 (file)
@@ -1,10 +1,13 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
 
-SDNC A1 Controller Developer Guide
-==================================
+Developer Guide
+===============
+
+This document provides a quickstart for developers of the Non-RT RIC.
 
-This document provides a quickstart for developers of the O-RAN SC A1 Controller SDNC Application
+SDNC A1 Controller
+==================
 
 Prerequisites
 -------------
@@ -15,6 +18,8 @@ Prerequisites
 4. Docker, version 19.03.1 or later
 5. Docker Compose, version 1.24.1 or later
 
+Build and run
+-------------
 Go to the northbound directory and run this command ::
     mvn clean install
 
@@ -40,8 +45,9 @@ 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:
+============
+
+The O-RAN Non-RT RIC Policy Agent 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
@@ -51,32 +57,9 @@ The O-RAN NonRT RIC PolicyAgent provides a REST API for management of policices.
    * 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
-=====================================
-
-Prerequisites
--------------
-
-1. Java development kit (JDK), version 8
-2. Maven dependency-management tool, version 3.4 or later
-
-Go to the nearric-simulator/ directory and run this command ::
-     mvn clean install
-
-If you want to genereate the sources from A1 yaml file, Go to nearric-simulator/a1-med-api/ and run this command ::
-     mvn generate-sources
-
-This will generate the A1PApi.java you need to call the generate-sources maven life cycle to generate the file
-
-The backend server listens for requests at this URL:
-   http://localhost:8080
 
-The backend server publishes live API documentation at the URL
-   http://localhost:8080/swagger-ui.html
+| The Policy Agent 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 to the README file of Policy Agent to know more about the API's.
 
 End-to-end call
 ===============