X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=31317c066811cb209edade744ebb0e41e3888a1f;hb=b2bc53f209bd27b6f0fabf630d22667c573365fd;hp=995f4ebd27d07b1017375acd45209616b57fb545;hpb=9c2bfab6a9c8a40b8336ab4d457dd2feae9a149c;p=nonrtric.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 995f4ebd..31317c06 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,40 +1,46 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 - - +.. Copyright (C) 2021 Nordix Installation Guide ================== -.. contents:: - :depth: 3 - :local: - 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 components, their dependencies and required system resources. + +Preface +------- + +See the README file in the "`docker-compose `" folder for more information. + +Software Installation and Deployment +------------------------------------ + +Install with Docker ++++++++++++++++++++ + +Docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following +command to start the components: -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. + .. code-block:: bash -.. _api-docs page: ./api-docs.html + docker-compose -f docker-compose.yaml + -f policy-service/docker-compose.yaml + -f ics/docker-compose.yaml -Version history +The example above is just an example to start some of the components. +For more information on running and configuring the functions can be found in the Readme file in the "`docker-compose `" folder, and on the `wiki page ` -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2019-11-12 | 0.1.0 | Maxime Bonneau | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 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