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