| elinuxhenrik | 02cb601 | 2022-04-04 13:07:36 +0200 | [diff] [blame] | 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 | Software Installation and Deployment |
| 14 | ------------------------------------ |
| 15 | |
| 16 | Install with Docker |
| 17 | +++++++++++++++++++ |
| 18 | |
| 19 | Docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following |
| 20 | command to start the components: |
| 21 | |
| 22 | .. code-block:: bash |
| 23 | |
| 24 | docker-compose -f docker-compose.yaml |
| 25 | -f policy-service/docker-compose.yaml |
| 26 | -f ics/docker-compose.yaml |
| 27 | |
| 28 | The example above is just an example to start some of the components. |
| 29 | 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>`_ |
| 30 | |
| 31 | Install with Helm |
| 32 | +++++++++++++++++ |
| 33 | |
| 34 | Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_, |
| 35 | under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which |
| 36 | components that will be installed can be controlled. Then the components can be installed and started by running the |
| 37 | following command: |
| 38 | |
| 39 | .. code-block:: bash |
| 40 | |
| 41 | bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml |