8cd01612b2daeb8cb1d32626eb47a456ebba114b
[portal/nonrtric-controlpanel.git] / 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) 2020 Nordix
4
5 Installation Guide
6 ==================
7
8 Abstract
9 --------
10
11 This document describes how to install the Non-RT RIC Control Panel, its dependencies and required system resources.
12
13
14 The Non-RT RIC Control Panel is a graphical user interface that enables the user to view and manage the A1 policies in
15 the RAN and also view producers and jobs for the Enrichement Information coordinator service.
16
17 Preface
18 -------
19
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.
23
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
28 Software Installation and Deployment
29 ------------------------------------
30
31 .. note::
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.
35
36 Install with Docker
37 +++++++++++++++++++
38
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:
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
47
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>`__,
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