docs/developer-guide.rst

   1 .. ============LICENSE_START=======================================================
   2 .. Copyright (C) 2019 Nordix Foundation.
   3 .. ================================================================================
   4 .. Licensed under the Apache License, Version 2.0 (the "License");
   5 .. you may not use this file except in compliance with the License.
   6 .. You may obtain a copy of the License at
   7 ..
   8 ..      http://www.apache.org/licenses/LICENSE-2.0
   9 ..
  10 .. Unless required by applicable law or agreed to in writing, software
  11 .. distributed under the License is distributed on an "AS IS" BASIS,
  12 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 .. See the License for the specific language governing permissions and
  14 .. limitations under the License.
  15 ..
  16 .. SPDX-License-Identifier: Apache-2.0
  17 .. ============LICENSE_END=========================================================
  18
  19 A1 Mediation:
  20 1. SDNC Controller
  21 2. Near-RT RIC Simulator
  22
  23 **********************************
  24 SDNC A1 Controller Developer Guide
  25 **********************************
  26
  27 This document provides a quickstart for developers of the O-RAN SC A1 Controller SDNC Application
  28
  29 Prerequisites
  30 -------------
  31
  32 1. Java development kit (JDK), version 8
  33 2. Maven dependency-management tool, version 3.4 or later
  34 3. Python, version 2
  35 4. Docker, version 19.03.1 or later
  36 5. Docker Compose, version 1.24.1 or later
  37
  38 Go to the northbound directory and run this command ::
  39     mvn clean install
  40
  41 This will build the project and create artifcats in maven repo
  42
  43 Go to oam/installation directory and run this command ::
  44     mvn clean install -P docker
  45
  46 This will create the docker images required for sdnc
  47
  48 After this step check for the docker images created by the maven build with this command ::
  49     docker images | grep sdnc
  50
  51 Go to oam/installation/src/main/yaml and run this command ::
  52     docker-compose up -d sdnc
  53
  54 This will create the docker containers with the sdnc image, you can check the status of the docker container using ::
  55     docker-compose logs -f sdnc
  56
  57 The SDNC url to access the Northbound API,
  58     http://localhost:8282/apidoc/explorer/index.html
  59
  60 Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
  61
  62 *************************************
  63 Near-RT RIC Simulator Developer Guide
  64 *************************************
  65
  66 Prerequisites
  67 -------------
  68
  69 1. Java development kit (JDK), version 8
  70 2. Maven dependency-management tool, version 3.4 or later
  71
  72 Go to the nearric-simulator/ directory and run this command ::
  73      mvn clean install
  74
  75 If you want to genereate the sources from A1 yaml file, Go to nearric-simulator/a1-med-api/ and run this command ::
  76      mvn generate-sources
  77
  78 This will generate the A1PApi.java you need to call the generate-sources maven life cycle to generate the file
  79
  80 The backend server listens for requests at this URL:
  81    http://localhost:8080
  82
  83 The backend server publishes live API documentation at the URL
  84    http://localhost:8080/swagger-ui.html
  85
  86 ***************
  87 End-to-end call
  88 ***************
  89
  90 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
  91
  92 .. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166