X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=c19a2d404f644ad89c0b53ad03bb7c3720aa3131;hb=3724a5ee563ed1635c5f4de1032d9c966873cc52;hp=26c9133f1d9b29529e4f66fd3f04b93d0c922cbd;hpb=fd5e1f38fac7e52c0a975051c9e09a8b2c257bee;p=nonrtric.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 26c9133f..c19a2d40 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,71 +1,43 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2020 Nordix +.. Copyright (C) 2021 Nordix Installation Guide ================== -.. contents:: - :depth: 3 - :local: - Abstract -------- -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. - -.. _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 +This document describes how to install the Non-RT RIC components, their dependencies and required system resources. - Build oam project with command: +Preface +------- - mvn clean install -Dmaven.test.skip=true -P docker +See the README file in the "docker-compose" folder for more information. - Enter into this directory: +Software Installation and Deployment +------------------------------------ - cd nonrtric/sdnc-a1-controller/oam/installation/src/main/yaml +Install with Docker ++++++++++++++++++++ - and run the command: +Docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following +command to start the components: - MTU=1500 docker-compose up a1-controller + .. code-block:: bash -Version history ---------------- + docker-compose -f docker-compose.yaml + -f policy-service/docker-compose.yaml + -f ecs/docker-compose.yaml -+--------------------+--------------------+--------------------+--------------------+ -| **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 | | | -| | | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ +Install with Helm ++++++++++++++++++ +Helm charts and an example recipe are provided in the `it/dep repo `__, +under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which +components that will be installed can be controlled. Then the components can be installed and started by running the +following comand: + .. code-block:: bash + bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml