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-2023 Nordix Foundation
   4 .. Copyright (C) 2024: OpenInfra Foundation Europe. All rights reserved.
   5
   6 Installation Guide
   7 ==================
   8
   9 Abstract
  10 --------
  11
  12 This document describes how to install the Non-RT RIC components, their dependencies and required system resources.
  13
  14 Software Installation and Deployment
  15 ------------------------------------
  16
  17 Install with Docker
  18 +++++++++++++++++++
  19
  20 Information on running and configuring the functions in Docker can be found
  21 on the `Run in Docker wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+J+-+Run+in+Docker>`_
  22
  23 Install with Helm
  24 +++++++++++++++++
  25
  26 Information on running and configuring the functions in Kubernetes can be found
  27 on the `Run in Kubernetes wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+J+-+Run+in+Kubernetes>`_
  28
  29 Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_,
  30 under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which
  31 components that will be installed can be controlled. Then the components can be installed and started by running the
  32 following command:
  33
  34       .. code-block:: bash
  35
  36         bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml