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 SDNC A1 Controller Developer Guide
   5 ==================================
   6
   7 This document provides a quickstart for developers of the O-RAN SC A1 Controller SDNC Application
   8
   9 Prerequisites
  10 -------------
  11
  12 1. Java development kit (JDK), version 8
  13 2. Maven dependency-management tool, version 3.4 or later
  14 3. Python, version 2
  15 4. Docker, version 19.03.1 or later
  16 5. Docker Compose, version 1.24.1 or later
  17
  18 Go to the northbound directory and run this command ::
  19     mvn clean install
  20
  21 This will build the project and create artifcats in maven repo
  22
  23 Go to oam/installation directory and run this command ::
  24     mvn clean install -P docker
  25
  26 This will create the docker images required for sdnc
  27
  28 After this step check for the docker images created by the maven build with this command ::
  29     docker images | grep sdnc
  30
  31 Go to oam/installation/src/main/yaml and run this command ::
  32     docker-compose up -d sdnc
  33
  34 This will create the docker containers with the sdnc image, you can check the status of the docker container using ::
  35     docker-compose logs -f sdnc
  36
  37 The SDNC url to access the Northbound API,
  38     http://localhost:8282/apidoc/explorer/index.html
  39
  40 Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
  41
  42 Policy Agent
  43 =====================================
  44 The O-RAN NonRT RIC PolicyAgent provides a REST API for management of policices. It provides support for:
  45
  46  * Supervision of clients (R-APPs) to eliminate stray policies in case of failure
  47  * Consistency monitoring of the SMO view of policies and the actual situation in the RICs
  48  * Consistency monitoring of RIC capabilities (policy types)
  49  * Policy configuration. This includes:
  50
  51    * One REST API towards all RICs in the network
  52    * Query functions that can find all policies in a RIC, all policies owned by a service (R-APP), all policies of a type etc.
  53    * Maps O1 resources (ManagedElement) as defined in O1 to the controlling RIC.
  54
  55 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.
  56
  57
  58 Near-RT RIC Simulator Developer Guide
  59 =====================================
  60
  61 Prerequisites
  62 -------------
  63
  64 1. Java development kit (JDK), version 8
  65 2. Maven dependency-management tool, version 3.4 or later
  66
  67 Go to the nearric-simulator/ directory and run this command ::
  68      mvn clean install
  69
  70 If you want to genereate the sources from A1 yaml file, Go to nearric-simulator/a1-med-api/ and run this command ::
  71      mvn generate-sources
  72
  73 This will generate the A1PApi.java you need to call the generate-sources maven life cycle to generate the file
  74
  75 The backend server listens for requests at this URL:
  76    http://localhost:8080
  77
  78 The backend server publishes live API documentation at the URL
  79    http://localhost:8080/swagger-ui.html
  80
  81 End-to-end call
  82 ===============
  83
  84 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
  85
  86 .. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166