X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=bf843fc951b353ed467dfdba54fadb443330860f;hb=refs%2Fheads%2Fmaster;hp=d7df04e17b4ddeeb2b04f4e98a3d7373670857e3;hpb=3c2c02c35b6d6b940e3e7533b0fa7f62b3a82d86;p=portal%2Fnonrtric-controlpanel.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index d7df04e..bf843fc 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,38 +1,58 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 - - +.. Copyright (C) 2021 Nordix Installation Guide ================== -.. contents:: - :depth: 3 - :local: - Abstract -------- -This document describes how to install the Non-RT RIC Controlpanel, its dependencies and required system resources. +This document describes how to install the Non-RT RIC Control Panel, its dependencies and required system resources. + + +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. + +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 `__ +for how to install and set them up. + +This guide is to install both the NonRtRIC Control Panel and the NonRtRIC Service Gateway. + +The installation of the NonRtRIC Service Gateway is needed as it exposes A1 Policy Management Service and Information Coordinator Service. + +Software Installation and Deployment +------------------------------------ + +.. note:: + 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. + +Install with Docker ++++++++++++++++++++ + +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: -This work is in progress. For now, it is possible to use the Non-RT RIC Controlpanel. + .. code-block:: bash -Version history + docker-compose -f docker-compose.yaml + -f control-panel/docker-compose.yaml + -f nonrtric-gateway/docker-compose.yaml -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2020-03-27 | 0.1.0 | Henrik Andersson | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 1.0 | | | -| | | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ +Install with Helm ++++++++++++++++++ +Helm charts and an example recipe are provided in the `it/dep repo `__, +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