docs/installation-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2021 Nordix
   4
   5 Installation Guide
   6 ==================
   7
   8 Abstract
   9 --------
  10
  11 This document describes how to install the Non-RT RIC components, their dependencies and required system resources.
  12
  13 Preface
  14 -------
  15
  16 See the README file in the "docker-compose" folder for more information.
  17
  18 Software Installation and Deployment
  19 ------------------------------------
  20
  21 Install with Docker
  22 +++++++++++++++++++
  23
  24 Docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following
  25 command to start the components:
  26
  27       .. code-block:: bash
  28
  29          docker-compose -f docker-compose.yaml
  30            -f policy-service/docker-compose.yaml
  31            -f ecs/docker-compose.yaml
  32
  33 Install with Helm
  34 +++++++++++++++++
  35
  36 Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`__,
  37 under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which
  38 components that will be installed can be controlled. Then the components can be installed and started by running the
  39 following comand:
  40
  41       .. code-block:: bash
  42
  43         bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml