| aravind.est | ac245e1 | 2023-11-27 15:17:22 +0000 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| aravind.est | b46499a | 2024-02-23 13:55:16 +0000 | [diff] [blame] | 3 | .. Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved. |
| aravind.est | ac245e1 | 2023-11-27 15:17:22 +0000 | [diff] [blame] | 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 Helm |
| 17 | +++++++++++++++++ |
| 18 | |
| 19 | Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_, |
| 20 | under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which |
| 21 | components that will be installed can be controlled. Then the components can be installed and started by running the |
| 22 | following command: |
| 23 | |
| 24 | .. code-block:: bash |
| 25 | |
| 26 | bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml |
| 27 | |
| 28 | Install with dependent components |
| 29 | +++++++++++++++++++++++++++++++++ |
| 30 | |
| 31 | The scripts for the deployments of rApp Manager and its dependent components are available in *rappmanager/scripts/install* directory. |
| 32 | |
| 33 | ACM components should be configured with couple of other components for the participants to work. |
| 34 | |
| 35 | In case some of the installation is already setup or not set by the installation scripts, the below environment variables can be used to set the configurations ACM through installation scripts. |
| 36 | |
| 37 | +--------------------+--------------------------------------------+----------------------------------------------+ |
| 38 | | **Variable Name** | **Description** | **Default Value** | |
| 39 | +--------------------+--------------------------------------------+----------------------------------------------+ |
| aravind.est | b46499a | 2024-02-23 13:55:16 +0000 | [diff] [blame] | 40 | | CHART_REPO_GET_URI | URI to get the charts. | \http://IP_ADDRESS:8879/charts | |
| aravind.est | ac245e1 | 2023-11-27 15:17:22 +0000 | [diff] [blame] | 41 | | | | | |
| aravind.est | b46499a | 2024-02-23 13:55:16 +0000 | [diff] [blame] | 42 | | | It will be used by Kubernetes participant | IP_ADDRESS: IP of the host in which | |
| 43 | | | and sample rApp generator | the installation scripts are running. | |
| 44 | +--------------------+--------------------------------------------+----------------------------------------------+ |
| 45 | | CHART_REPO_POST_URI| URI to upload the charts. | \http://IP_ADDRESS:8879/charts/api/charts | |
| 46 | | | | | |
| 47 | | | It will be used by sample rApp generator | IP_ADDRESS: IP of the host in which | |
| aravind.est | ac245e1 | 2023-11-27 15:17:22 +0000 | [diff] [blame] | 48 | | | | the installation scripts are running. | |
| 49 | +--------------------+--------------------------------------------+----------------------------------------------+ |
| 50 | | A1PMS_HOST | Address of the A1PMS. | \http://policymanagementservice.nonrtric:9080| |
| 51 | | | | | |
| 52 | | | It will be accessed from A1PMS participant.| | |
| 53 | +--------------------+--------------------------------------------+----------------------------------------------+ |
| 54 | |
| 55 | All components can be installed using the command below, |
| 56 | |
| 57 | .. code-block:: bash |
| 58 | |
| 59 | ./install-all.sh |
| 60 | |
| 61 | Individual components can be installed using the commands below, |
| 62 | |
| 63 | To install the tools required for other installer scripts. |
| 64 | |
| 65 | .. code-block:: bash |
| 66 | |
| 67 | ./install-base.sh |
| 68 | |
| 69 | To install the ACM, and it's related components. |
| 70 | |
| 71 | .. code-block:: bash |
| 72 | |
| 73 | ./install-acm.sh |
| 74 | |
| 75 | To install the Kserve, and it's related components. |
| 76 | |
| 77 | .. code-block:: bash |
| 78 | |
| 79 | ./install-kserve.sh |
| 80 | |
| 81 | To installs the NONRTRIC components. |
| 82 | |
| 83 | .. code-block:: bash |
| 84 | |
| 85 | ./install-nonrtric.sh |
| 86 | |
| 87 | |
| 88 | Uninstallation |
| 89 | ++++++++++++++ |
| 90 | To uninstall all the components |
| 91 | |
| 92 | .. code-block:: bash |
| 93 | |
| 94 | ./uninstall-all.sh |