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