.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2020 Nordix
Developer Guide
===============
This document provides a quickstart for developers of the Non-RT RIC.
SDNC A1 Controller
-==================================
+==================
Prerequisites
-------------
-1. Java development kit (JDK), version 8
-2. Maven dependency-management tool, version 3.4 or later
-3. Python, version 2
-4. Docker, version 19.03.1 or later
-5. Docker Compose, version 1.24.1 or later
+1. Java development kit (JDK), version 11
+2. Maven dependency-management tool, version 3.6 or later
+3. Python, version 2 or later
+4. Docker, version 19.03.1 or latest
+5. Docker Compose, version 1.24.1 or latest
Build and run
-------------
Go to the northbound directory and run this command ::
- mvn clean install
+ mvn clean install -Dmaven.test.skip=true
This will build the project and create artifcats in maven repo
Go to oam/installation directory and run this command ::
mvn clean install -P docker
-This will create the docker images required for sdnc
+This will create the docker images required for a1-controller.
After this step check for the docker images created by the maven build with this command ::
- docker images | grep sdnc
+ docker images | grep a1-controller
Go to oam/installation/src/main/yaml and run this command ::
- docker-compose up -d sdnc
+ docker-compose up -d a1-controller
-This will create the docker containers with the sdnc image, you can check the status of the docker container using ::
- docker-compose logs -f sdnc
+This will create the docker containers with the a1-controller image, you can check the status of the docker container using ::
+ docker-compose logs -f a1-controller
-The SDNC url to access the Northbound API,
+The Open Daylight GUI url to access the Northbound API,
http://localhost:8282/apidoc/explorer/index.html
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
* 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
Code Review / nonrtric.git / blobdiff