X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=973319b51df7d430961beb2be1bd0f6bc846ca95;hb=eaaee91b1defd671d06bcdfb69047e356956b77f;hp=995f4ebd27d07b1017375acd45209616b57fb545;hpb=bd97ef0a69e5c83fc48785f0bf98eb80f2c30e8f;p=nonrtric.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 995f4ebd..973319b5 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -13,13 +13,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 +60,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 | | |