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 A1 Mediation:
   5 1. SDNC Controller
   6 2. Near-RT RIC Simulator
   7
   8 SDNC A1 Controller Developer Guide
   9 ==================================
  10
  11 This document provides a quickstart for developers of the O-RAN SC A1 Controller SDNC Application
  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 Go to the northbound directory and run this command ::
  23     mvn clean install
  24
  25 This will build the project and create artifcats in maven repo
  26
  27 Go to oam/installation directory and run this command ::
  28     mvn clean install -P docker
  29
  30 This will create the docker images required for sdnc
  31
  32 After this step check for the docker images created by the maven build with this command ::
  33     docker images | grep sdnc
  34
  35 Go to oam/installation/src/main/yaml and run this command ::
  36     docker-compose up -d sdnc
  37
  38 This will create the docker containers with the sdnc image, you can check the status of the docker container using ::
  39     docker-compose logs -f sdnc
  40
  41 The SDNC url to access the Northbound API,
  42     http://localhost:8282/apidoc/explorer/index.html
  43
  44 Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
  45
  46 Near-RT RIC Simulator Developer Guide
  47 =====================================
  48
  49 Prerequisites
  50 -------------
  51
  52 1. Java development kit (JDK), version 8
  53 2. Maven dependency-management tool, version 3.4 or later
  54
  55 Go to the nearric-simulator/ directory and run this command ::
  56      mvn clean install
  57
  58 If you want to genereate the sources from A1 yaml file, Go to nearric-simulator/a1-med-api/ and run this command ::
  59      mvn generate-sources
  60
  61 This will generate the A1PApi.java you need to call the generate-sources maven life cycle to generate the file
  62
  63 The backend server listens for requests at this URL:
  64    http://localhost:8080
  65
  66 The backend server publishes live API documentation at the URL
  67    http://localhost:8080/swagger-ui.html
  68
  69 End-to-end call
  70 ===============
  71
  72 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
  73
  74 .. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166