.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021 Nordix
Installation Guide
==================
This document describes how to install the Non-RT RIC Control Panel, its dependencies and required system resources.
-This work is in progress. For now, it is possible to use the Non-RT RIC Control Panel.
-Version history
----------------
+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 Information coordinator service.
-+--------------------+--------------------+--------------------+--------------------+
-| **Date** | **Ver.** | **Author** | **Comment** |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| 2020-03-27 | 0.1.0 | Henrik Andersson | First draft |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| 2021-04-27 | 2.2.0 | Yennifer Chacon | Update |
-| | | | documentation |
-+--------------------+--------------------+--------------------+--------------------+
-| | | | |
-| | | | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
+Preface
+-------
+Since the control Panel depends on the A1 Policy Management Service and Information Coordinator, they
+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>`__
+for how to install and set them up.
+This guide is to install both the NonRtRIC Control Panel and the NonRtRIC Service Gateway.
-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.
+The installation of the NonRtRIC Service Gateway is needed as it exposes A1 Policy Management Service and Information Coordinator Service.
-- To create docker image for the control panel:
-
- .. code-block:: bash
-
- cd nonrtric-controlpanel/webapp-frontend
- docker build -t o-ran-sc/nonrtric-controlpanel .
-
-- Nonrtric gateway is also needed because all the request from the gui are passed through this API gateway.
-
- .. code-block:: bash
-
- cd nonrtric-controlpanel/nonrtric-gateway
- docker build -t o-ran-sc/nonrtric-gateway .
+Software Installation and Deployment
+------------------------------------
.. note::
- It is important to note that all the route configurations are provided in application.yaml,
- so in case domain name and port for Policy Management Service & Enrichment Information Coordinator
- Service are not the default ones, application.yaml file must be modified.
-
-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.
-
- - nexus3.o-ran-sc.org:10004/o-ran-sc/nonrtric-enrichment-coordinator-service
- - nexus3.o-ran-sc.org:10004/o-ran-sc/nonrtric-policy-agent
+ It is important to note that all the route configurations are provided in the application.yaml file of the gateway.
+ So in case domain name and port for Policy Management Service and Information Coordinator Service
+ are not the default ones, the application.yaml file must be modified.
-`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.
+Install with Docker
++++++++++++++++++++
-
-- Using docker compose:
-
- 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.
-
- It will start all necessary services and provided sample data that can be viewed in the interface using docker compose command:
+Docker compose files are provided, in the "docker-compose" folder, to install the frontend and gateway. Run the following
+command to start the Control Panel:
.. code-block:: bash
docker-compose -f docker-compose.yaml
-f control-panel/docker-compose.yaml
-f nonrtric-gateway/docker-compose.yaml
- -f policy-service/docker-compose.yaml
- -f ecs/docker-compose.yaml
- -f a1-sim/docker-compose.yaml up
+Install with Helm
++++++++++++++++++
+
+Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`__,
+under "nonrtric". By modifying the variables named "installXXX" at the beginning of the example recipe file, the
+components that will be installed can be controlled. The components can be then be installed and started by running the
+following command:
+
+ .. code-block:: bash
+
+ bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml
Code Review / portal / nonrtric-controlpanel.git / blobdiff