| elinuxhenrik | 3c2c02c | 2020-03-27 15:59:32 +0100 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| elinuxhenrik | 616ea8d | 2020-04-15 08:26:35 +0200 | [diff] [blame] | 3 | .. Copyright (C) 2020 Nordix |
| elinuxhenrik | 3c2c02c | 2020-03-27 15:59:32 +0100 | [diff] [blame] | 4 | |
| 5 | Installation Guide |
| 6 | ================== |
| 7 | |
| elinuxhenrik | 3c2c02c | 2020-03-27 15:59:32 +0100 | [diff] [blame] | 8 | Abstract |
| 9 | -------- |
| 10 | |
| elinuxhenrik | 22cfc3d | 2020-03-30 08:53:58 +0200 | [diff] [blame] | 11 | This document describes how to install the Non-RT RIC Control Panel, its dependencies and required system resources. |
| elinuxhenrik | 3c2c02c | 2020-03-27 15:59:32 +0100 | [diff] [blame] | 12 | |
| elinuxhenrik | 3c2c02c | 2020-03-27 15:59:32 +0100 | [diff] [blame] | 13 | |
| elinuxhenrik | 1aa2b7f | 2021-05-31 13:19:09 +0200 | [diff] [blame] | 14 | The Non-RT RIC Control Panel is a graphical user interface that enables the user to view and manage the A1 policies in |
| ychacon | cb87bb8 | 2021-06-17 15:41:43 +0200 | [diff] [blame] | 15 | the RAN and also view producers and jobs for the Enrichement Information coordinator service. |
| elinuxhenrik | 3c2c02c | 2020-03-27 15:59:32 +0100 | [diff] [blame] | 16 | |
| elinuxhenrik | 1aa2b7f | 2021-05-31 13:19:09 +0200 | [diff] [blame] | 17 | Preface |
| 18 | ------- |
| elinuxhenrik | 3c2c02c | 2020-03-27 15:59:32 +0100 | [diff] [blame] | 19 | |
| elinuxhenrik | 1aa2b7f | 2021-05-31 13:19:09 +0200 | [diff] [blame] | 20 | Since the control Panel depends on the A1 Policy Management Service and A1 Enrichment Information Coordinator, they |
| 21 | must be installed to make it work. See `Non-RT RIC <https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/index.html>`__ |
| 22 | for how to install and set them up. |
| elinuxhenrik | 3c2c02c | 2020-03-27 15:59:32 +0100 | [diff] [blame] | 23 | |
| ychacon | cb87bb8 | 2021-06-17 15:41:43 +0200 | [diff] [blame] | 24 | This guide is to install both the NonRtRIC Control Panel and the NonRtRIC Service Gateway. |
| 25 | |
| 26 | The installation of the NonRtRIC Service Gateway is needed as it exposes A1 Policy Management Service and Enrichment Coordinator Service. |
| 27 | |
| elinuxhenrik | 1aa2b7f | 2021-05-31 13:19:09 +0200 | [diff] [blame] | 28 | Software Installation and Deployment |
| 29 | ------------------------------------ |
| ychacon | af912b9 | 2021-04-27 14:43:56 +0200 | [diff] [blame] | 30 | |
| 31 | .. note:: |
| elinuxhenrik | 1aa2b7f | 2021-05-31 13:19:09 +0200 | [diff] [blame] | 32 | It is important to note that all the route configurations are provided in the application.yaml file of the gateway. |
| 33 | So in case domain name and port for Policy Management Service and Enrichment Information Coordinator Service |
| 34 | are not the default ones, the application.yaml file must be modified. |
| ychacon | af912b9 | 2021-04-27 14:43:56 +0200 | [diff] [blame] | 35 | |
| elinuxhenrik | 1aa2b7f | 2021-05-31 13:19:09 +0200 | [diff] [blame] | 36 | Install with Docker |
| 37 | +++++++++++++++++++ |
| ychacon | af912b9 | 2021-04-27 14:43:56 +0200 | [diff] [blame] | 38 | |
| elinuxhenrik | 1aa2b7f | 2021-05-31 13:19:09 +0200 | [diff] [blame] | 39 | Docker compose files are provided, in the "docker-compose" folder, to install the frontend and gateway. Run the following |
| 40 | command to start the Control Panel: |
| ychacon | af912b9 | 2021-04-27 14:43:56 +0200 | [diff] [blame] | 41 | |
| 42 | .. code-block:: bash |
| 43 | |
| 44 | docker-compose -f docker-compose.yaml |
| 45 | -f control-panel/docker-compose.yaml |
| 46 | -f nonrtric-gateway/docker-compose.yaml |
| ychacon | af912b9 | 2021-04-27 14:43:56 +0200 | [diff] [blame] | 47 | |
| elinuxhenrik | 1aa2b7f | 2021-05-31 13:19:09 +0200 | [diff] [blame] | 48 | Install with Helm |
| 49 | +++++++++++++++++ |
| 50 | |
| 51 | Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`__, |
| elinuxhenrik | 6ba7038 | 2021-06-01 15:16:49 +0200 | [diff] [blame] | 52 | under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which |
| 53 | components that will be installed can be controlled. Then the components can be installed and started by running the |
| 54 | following comand: |
| 55 | |
| 56 | .. code-block:: bash |
| 57 | |
| 58 | bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml |