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. All rights Reserved
   4 .. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved
   5
   6 Installation Guide
   7 ==================
   8
   9 Abstract
  10 --------
  11
  12 This document describes how to install some of the Non-RT RIC components, their dependencies and required system resources.
  13
  14 Software Installation and Deployment
  15 ------------------------------------
  16
  17 Install with Helm in Kubernetes
  18 +++++++++++++++++++++++++++++++
  19
  20 The easiest and preferred way to install NONRTRIC functions is using Kubernetes, with installation instructions provided in Helm Charts.
  21 Full details of how to install NONRTRIC functions are provided in `Deploy NONRTRIC in Kubernetes <nonrtricwikik8s_>`_.
  22
  23 Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_,
  24 under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which
  25 components that will be installed can be controlled. Then the components can be installed and started by running the
  26 following command:
  27
  28       .. code-block:: bash
  29
  30         bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml
  31
  32 Install with Docker
  33 +++++++++++++++++++
  34
  35 Some NONRTRIC functions, and simpler usecases can be install directly using Docker.
  36 Full details of how to use Docker for NONRTRIC functions are provided in `Deploy NONRTRIC in Docker <nonrtricwikidocker_>`_.
  37
  38 Install with Docker Compose
  39 +++++++++++++++++++++++++++
  40
  41 Some older docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following
  42 command to start the components:
  43
  44       .. code-block:: bash
  45
  46          docker-compose -f docker-compose.yaml
  47            -f policy-service/docker-compose.yaml
  48            -f ics/docker-compose.yaml
  49
  50 The example above is just an example to start some of the components.
  51 For more information on running and configuring the functions can be found in the README file in the "`docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose>`_" folder, and on the `wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+E+-+Run+in+Docker>`_