docs/installation-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4
   5
   6 Installation Guide
   7 ==================
   8
   9 .. contents::
  10    :depth: 3
  11    :local:
  12
  13 Abstract
  14 --------
  15
  16 This document describes how to install the Non-RT RIC SDNC A1 Controller, its dependencies and required system resources.
  17
  18 This work is in progress. Please visit the `api-docs page`_ for more information about the SDNC A1 Controller and the Policy Agent.
  19
  20 .. _api-docs page: ./api-docs.html
  21
  22 Installation
  23 ------------
  24
  25 Download the SDNC repo:
  26
  27    git clone "https://gerrit.o-ran-sc.org/r/nonrtric"
  28
  29 The SDNC A1 Controller could be found in this repo.
  30
  31 Build SDNC project:
  32
  33    Enter into the sdnc-a1-controller project, northbound and oam project will located there.
  34
  35       cd sdnc-a1-controller
  36
  37    Build northbound project with command:
  38
  39       mvn clean install -Dmaven.test.skip=true
  40
  41    Build oam project with command:
  42
  43       mvn clean install -Dmaven.test.skip=true -P docker
  44
  45    Enter into this directory:
  46
  47       cd nonrtric/sdnc-a1-controller/oam/installation/src/main/yaml
  48
  49    and run the command:
  50
  51       MTU=1500 docker-compose up a1-controller
  52
  53 Version history
  54 ---------------
  55
  56 +--------------------+--------------------+--------------------+--------------------+
  57 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  58 |                    |                    |                    |                    |
  59 +--------------------+--------------------+--------------------+--------------------+
  60 | 2019-11-12         | 0.1.0              | Maxime Bonneau     | First draft        |
  61 |                    |                    |                    |                    |
  62 +--------------------+--------------------+--------------------+--------------------+
  63 | 2020-03-24         | 0.1.1              | Maxime Bonneau     | Second draft       |
  64 |                    |                    |                    |                    |
  65 +--------------------+--------------------+--------------------+--------------------+
  66 |                    | 1.0                |                    |                    |
  67 |                    |                    |                    |                    |
  68 |                    |                    |                    |                    |
  69 +--------------------+--------------------+--------------------+--------------------+
  70
  71
  72