| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| elinuxhenrik | 0a4c38b | 2020-04-14 10:59:36 +0200 | [diff] [blame] | 3 | .. Copyright (C) 2020 Nordix |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 4 | |
| 5 | Installation Guide |
| 6 | ================== |
| 7 | |
| 8 | .. contents:: |
| 9 | :depth: 3 |
| 10 | :local: |
| 11 | |
| 12 | Abstract |
| 13 | -------- |
| 14 | |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 15 | This document describes how to install the Non-RT RIC SDNC A1 Controller, its dependencies and required system resources. |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 16 | |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 17 | This work is in progress. Please visit the `api-docs page`_ for more information about the SDNC A1 Controller and the Policy Agent. |
| maximesson | 780b2bf | 2019-11-12 16:09:02 +0100 | [diff] [blame] | 18 | |
| 19 | .. _api-docs page: ./api-docs.html |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 20 | |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 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 | |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 52 | Version history |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 53 | --------------- |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 54 | |
| 55 | +--------------------+--------------------+--------------------+--------------------+ |
| 56 | | **Date** | **Ver.** | **Author** | **Comment** | |
| 57 | | | | | | |
| 58 | +--------------------+--------------------+--------------------+--------------------+ |
| maximesson | 780b2bf | 2019-11-12 16:09:02 +0100 | [diff] [blame] | 59 | | 2019-11-12 | 0.1.0 | Maxime Bonneau | First draft | |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 60 | | | | | | |
| 61 | +--------------------+--------------------+--------------------+--------------------+ |
| maximesson | eaaee91 | 2020-03-26 16:43:27 +0100 | [diff] [blame] | 62 | | 2020-03-24 | 0.1.1 | Maxime Bonneau | Second draft | |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 63 | | | | | | |
| 64 | +--------------------+--------------------+--------------------+--------------------+ |
| 65 | | | 1.0 | | | |
| 66 | | | | | | |
| 67 | | | | | | |
| 68 | +--------------------+--------------------+--------------------+--------------------+ |
| 69 | |
| 70 | |
| maximesson | e6b4d27 | 2019-10-31 13:26:13 +0100 | [diff] [blame] | 71 | |