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