X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=4a4f0131b95abaebe88d1f7748bdf042332addbe;hb=3c504be356d2ac9fc5195eb45692e1b756caa9f3;hp=995f4ebd27d07b1017375acd45209616b57fb545;hpb=780b2bff6684aa0b514088f9e291441692f29b3e;p=nonrtric.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 995f4ebd..4a4f0131 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,40 +1,51 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 - - +.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved +.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved 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 some of the Non-RT RIC components, their dependencies and required system resources. + +Software Installation and Deployment +------------------------------------ + +Install with Helm in Kubernetes ++++++++++++++++++++++++++++++++ + +The easiest and preferred way to install NONRTRIC functions is using Kubernetes, with installation instructions provided in Helm Charts. +Full details of how to install NONRTRIC functions are provided in `Deploy NONRTRIC in Kubernetes `_. + +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 command: + + .. code-block:: bash + + bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml -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. +Install with Docker ++++++++++++++++++++ -.. _api-docs page: ./api-docs.html +Some NONRTRIC functions, and simpler usecases can be install directly using Docker. +Full details of how to use Docker for NONRTRIC functions are provided in `Deploy NONRTRIC in Docker `_. -Version history +Install with Docker Compose ++++++++++++++++++++++++++++ -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2019-11-12 | 0.1.0 | Maxime Bonneau | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 1.0 | | | -| | | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ +Some older docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following +command to start the components: + .. code-block:: bash + docker-compose -f docker-compose.yaml + -f policy-service/docker-compose.yaml + -f ics/docker-compose.yaml +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 `_