X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=26c9133f1d9b29529e4f66fd3f04b93d0c922cbd;hb=824033853e6b3b52f9019283e85f21006596b0fb;hp=995f4ebd27d07b1017375acd45209616b57fb545;hpb=780b2bff6684aa0b514088f9e291441692f29b3e;p=nonrtric.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 995f4ebd..26c9133f 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,7 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 - - +.. Copyright (C) 2020 Nordix Installation Guide ================== @@ -13,13 +12,45 @@ Installation Guide Abstract -------- -This document describes how to install the Non-RT RIC dashboard, its dependencies and required system resources. +This document describes how to install the Non-RT RIC SDNC A1 Controller, its dependencies and required system resources. -This work is in progress. For now, it is possible to use the Non-RT RIC dashboard. Please visit the `api-docs page`_ for more on how to deploy it and use it. +This work is in progress. Please visit the `api-docs page`_ for more information about the SDNC A1 Controller and the Policy Agent. .. _api-docs page: ./api-docs.html +Installation +------------ + +Download the SDNC repo: + + git clone "https://gerrit.o-ran-sc.org/r/nonrtric" + +The SDNC A1 Controller could be found in this repo. + +Build SDNC project: + + Enter into the sdnc-a1-controller project, northbound and oam project will located there. + + cd sdnc-a1-controller + + Build northbound project with command: + + mvn clean install -Dmaven.test.skip=true + + Build oam project with command: + + mvn clean install -Dmaven.test.skip=true -P docker + + Enter into this directory: + + cd nonrtric/sdnc-a1-controller/oam/installation/src/main/yaml + + and run the command: + + MTU=1500 docker-compose up a1-controller + Version history +--------------- +--------------------+--------------------+--------------------+--------------------+ | **Date** | **Ver.** | **Author** | **Comment** | @@ -28,7 +59,7 @@ Version history | 2019-11-12 | 0.1.0 | Maxime Bonneau | First draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | +| 2020-03-24 | 0.1.1 | Maxime Bonneau | Second draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ | | 1.0 | | |