Documentation reorganisation
[nonrtric.git] / docs / developer-guide.rst
index b3651f4..5402328 100644 (file)
@@ -7,7 +7,7 @@ Developer Guide
 This document provides a quickstart for developers of the Non-RT RIC.
 
 SDNC A1 Controller
-==================================
+==================
 
 Prerequisites
 -------------
@@ -45,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
@@ -57,39 +58,12 @@ The O-RAN NonRT RIC PolicyAgent provides a REST API for management of policices.
    * 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 to the README file of PolicyAgent to know more about the API's.
-
-
-Near-RT RIC Simulator
-=====================================
-
-
-Prerequisites
--------------
- 1. Java development kit (JDK), version 8
- 2. Maven dependency-management tool, version 3.4 or later
-
-Build and run
--------------
-
-Go to the near-rt-ric-simulator/ric-plt-a1/ directory and run this command::
-     mvn clean install
-The docker image can be built using::
-    docker build -t {desiredImageName} .
-The image can be run using the command::
-    docker run -it -p {desiredPort}:8085 {desiredImageName}
-
-The functions written in *a1.py* are the ones matching the requests listed in the A1 open api yaml file. The functions written in *main.py* are the ones used for development purpose.
-
-Different error codes can be thrown back according to the yaml file. In order to simulate an error code, simply add the query ?code={desiredCodeNumber} at the end of the address in the curl request.
-
-For running the simulator outside of a docker container, run ./run_me.sh. It is possible to use the port of your choice, by adding it in the command: ./run_me.sh {desiredPort}.
-After that, it is the exact same use with or without a container.
+| 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
 ===============
 
 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