docs/developer-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3
   4 Developer Guide
   5 ===============
   6
   7 This document provides a quickstart for developers of the Non-RT RIC.
   8
   9 SDNC A1 Controller
  10 ==================
  11
  12 Prerequisites
  13 -------------
  14
  15 1. Java development kit (JDK), version 8
  16 2. Maven dependency-management tool, version 3.4 or later
  17 3. Python, version 2
  18 4. Docker, version 19.03.1 or later
  19 5. Docker Compose, version 1.24.1 or later
  20
  21 Build and run
  22 -------------
  23 Go to the northbound directory and run this command ::
  24     mvn clean install
  25
  26 This will build the project and create artifcats in maven repo
  27
  28 Go to oam/installation directory and run this command ::
  29     mvn clean install -P docker
  30
  31 This will create the docker images required for sdnc
  32
  33 After this step check for the docker images created by the maven build with this command ::
  34     docker images | grep sdnc
  35
  36 Go to oam/installation/src/main/yaml and run this command ::
  37     docker-compose up -d sdnc
  38
  39 This will create the docker containers with the sdnc image, you can check the status of the docker container using ::
  40     docker-compose logs -f sdnc
  41
  42 The SDNC url to access the Northbound API,
  43     http://localhost:8282/apidoc/explorer/index.html
  44
  45 Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
  46
  47 Policy Agent
  48 ============
  49
  50 The O-RAN Non-RT RIC Policy Agent provides a REST API for management of policices. It provides support for:
  51
  52  * Supervision of clients (R-APPs) to eliminate stray policies in case of failure
  53  * Consistency monitoring of the SMO view of policies and the actual situation in the RICs
  54  * Consistency monitoring of RIC capabilities (policy types)
  55  * Policy configuration. This includes:
  56
  57    * One REST API towards all RICs in the network
  58    * Query functions that can find all policies in a RIC, all policies owned by a service (R-APP), all policies of a type etc.
  59    * Maps O1 resources (ManagedElement) as defined in O1 to the controlling RIC.
  60
  61 | The Policy Agent can be accessed over the REST API or through the DMaaP Interface. The REST API is documented in the
  62 | *nonrtric/policy-agent/docs/api.yaml* file. Please refer to the README file of Policy Agent to know more about the API's.
  63
  64 End-to-end call
  65 ===============
  66
  67 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
  68
  69 .. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166