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=34482339c9619fe5be4b78dc7a48083862178f04;hpb=1aa2b7f51392e7f97334315e443e4d08e08873a6;p=portal%2Fnonrtric-controlpanel.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 3448233..bf843fc 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,6 +1,6 @@ .. 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 ================== @@ -12,21 +12,25 @@ This document describes how to install the Non-RT RIC Control Panel, its depende 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 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 A1 Enrichment Information Coordinator, they +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 Enrichment Information Coordinator Service + 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 @@ -45,4 +49,10 @@ Install with Helm +++++++++++++++++ Helm charts and an example recipe are provided in the `it/dep repo `__, -under "nonrtric". +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