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 This work is in progress. For now, it is possible to use the Non-RT RIC Control Panel.
  14
  15 Version history
  16 ---------------
  17
  18 +--------------------+--------------------+--------------------+--------------------+
  19 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  20 |                    |                    |                    |                    |
  21 +--------------------+--------------------+--------------------+--------------------+
  22 | 2020-03-27         | 0.1.0              | Henrik Andersson   | First draft        |
  23 |                    |                    |                    |                    |
  24 +--------------------+--------------------+--------------------+--------------------+
  25 | 2021-04-27         | 2.2.0              | Yennifer Chacon    | Update             |
  26 |                    |                    |                    | documentation      |
  27 +--------------------+--------------------+--------------------+--------------------+
  28 |                    |                    |                    |                    |
  29 |                    |                    |                    |                    |
  30 |                    |                    |                    |                    |
  31 +--------------------+--------------------+--------------------+--------------------+
  32
  33
  34
  35 The Non-RT RIC Control Panel is a graphical user interface that enables the user to view and manage the A1 policies in the RAN and also view producers and jobs for the Enrichement Information coordinator service.
  36
  37 - To create docker image for the control panel:
  38
  39    .. code-block:: bash
  40
  41       cd nonrtric-controlpanel/webapp-frontend
  42       docker build -t o-ran-sc/nonrtric-controlpanel .
  43
  44 - Nonrtric gateway is also needed because all the request from the gui are passed through this API gateway.
  45
  46    .. code-block:: bash
  47
  48       cd nonrtric-controlpanel/nonrtric-gateway
  49       docker build -t o-ran-sc/nonrtric-gateway .
  50
  51 .. note::
  52    It is important to note that all the route configurations are provided in application.yaml,
  53    so in case domain name and port for Policy Management Service & Enrichment Information Coordinator
  54    Service are not the default ones, application.yaml file must be modified.
  55
  56 Docker images for Policy Management and Enrichment Information Coordinator are needed as well in order to view information and data on the interface. These images can be found in the nexus repository or can be built manually as well.
  57
  58    - nexus3.o-ran-sc.org:10004/o-ran-sc/nonrtric-enrichment-coordinator-service
  59    - nexus3.o-ran-sc.org:10004/o-ran-sc/nonrtric-policy-agent
  60
  61 `Wiki page <https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=20878049>`_ contain detail information about how to build this images and add some sample data.
  62
  63
  64 - Using docker compose:
  65
  66    Another alternative is to use docker compose. In the `nonrtric project <https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric>`_ under the folder docker-compose, instructions can be found in the README file.
  67
  68    It will start all necessary services and provided sample data that can be viewed in the interface using docker compose command:
  69
  70       .. code-block:: bash
  71
  72          docker-compose -f docker-compose.yaml
  73                         -f control-panel/docker-compose.yaml
  74                         -f nonrtric-gateway/docker-compose.yaml
  75                         -f policy-service/docker-compose.yaml
  76                         -f ecs/docker-compose.yaml
  77                         -f a1-sim/docker-compose.yaml up
  78