X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=973319b51df7d430961beb2be1bd0f6bc846ca95;hb=f85d5640c9e3ebec82f6de62d0f1c9d70efe8945;hp=f78a5eec2401e25c71d77f9f8342794449e73796;hpb=e94200843789d401cd13a3b87dc19ae0cc73974f;p=nonrtric.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index f78a5eec..973319b5 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -13,97 +13,60 @@ 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. Please visit the `api-docs page`_ for more information about the SDNC A1 Controller and the Policy Agent. -Version history - -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 20XX-XX-XX | 0.1.0 | | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 1.0 | | | -| | | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ +.. _api-docs page: ./api-docs.html - -Introduction +Installation ------------ -.. - -.: - -This document describes the supported software and hardware configurations for the reference component as well as providing guidelines on how to install and configure such reference system. - -The audience of this document is assumed to have good knowledge in RAN network and Linux system. +Download the SDNC repo: + git clone "https://gerrit.o-ran-sc.org/r/nonrtric" -Preface -------- -.. +The SDNC A1 Controller could be found in this repo. -: +Build SDNC project: -Before starting the installation of , some planning must precede. + Enter into the sdnc-a1-controller project, northbound and oam project will located there. -.. note:any preperation you need before setting up sotfware and hardware + cd sdnc-a1-controller + Build northbound project with command: -Hardware Requirements ---------------------- -.. + mvn clean install -Dmaven.test.skip=true -: + Build oam project with command: -Following minimum hardware requirements must be met for installation of : + mvn clean install -Dmaven.test.skip=true -P docker -+--------------------+----------------------------------------------------+ -| **HW Aspect** | **Requirement** | -| | | -+--------------------+----------------------------------------------------+ -| **# of servers** | | -+--------------------+----------------------------------------------------+ -| **CPU** | | -| | | -+--------------------+----------------------------------------------------+ -| **RAM** | | -| | | -+--------------------+----------------------------------------------------+ -| **Disk** | | -| | | -+--------------------+----------------------------------------------------+ -| **NICs** | | -| | | -| | | -| | | -| | | -| | | -+--------------------+----------------------------------------------------+ + Enter into this directory: + cd nonrtric/sdnc-a1-controller/oam/installation/src/main/yaml + and run the command: -Software Installation and Deployment ------------------------------------- -.. + MTU=1500 docker-compose up a1-controller -: - -This section describes the installation of the installation on the reference hardware. - - - -References ----------- -.. +Version history +--------------- ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2019-11-12 | 0.1.0 | Maxime Bonneau | First draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2020-03-24 | 0.1.1 | Maxime Bonneau | Second draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | 1.0 | | | +| | | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+