X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Foverview.rst;h=1ac93dae32d9572f16ce9573d9e6fed6db9f57e7;hb=HEAD;hp=ec14eb637f955f58085ff8ccf2214f0bd900247c;hpb=31c7da20a7f77246cc1091962dc1f7b4016352b6;p=portal%2Fnonrtric-controlpanel.git diff --git a/docs/overview.rst b/docs/overview.rst index ec14eb6..1ac93da 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,24 +1,33 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2020 Nordix +.. Copyright (C) 2021 Nordix -Control Panel Overview -====================== +Non-RT RIC Control Panel Overview +================================= -The Non-RT RIC Control Panel is a graphical user interface that enables the user to manage the Policies in the -network. The Control Panel interacts with the Policy Agent via a REST API. -The Control Panel generates its GUI from JSON schemas in a model driven fashion. +Graphical user interface with the following capabilities: -The Control Panel consists of a back end implemented as a Java Spring Boot application and a fronted developed using the -Angular framework. +* View and Manage A1 policies in the RAN (near-RT-RICs) +* Graphical A1 policy creation/editing is model-driven, based on policy type’s JSON schema +* View producers and jobs for the Information coordinator service +* Configure A1 Policy Management Service (add/remove near-rt-rics) + +The Control Panel frontend interacts with the A1 Policy Management Service and A1 Information Coordinator +(REST NBIs) via a service exposure gateway, the Nonrtric Gateway. The frontend is developed using the Angular framework. +The Gateway is a Spring Cloud Gateway that provides an API Gateway for all the Non-RT-RIC Components. + +.. note:: + It is fully supported in Firefox and Chrome. Minor issues in Safari. + Not supported in Microsoft Edge and IE. Control Panel architecture -------------------------- The architecture of the Control Panel is as shown on the following picture: -.. image:: ./images/architecture.png +.. image:: ./images/ControlPanel_architecture.png :scale: 50 % -The Control Panel itself is split into the backend and the frontend, and can be deployed following the instructions in -the README.md file in the repo. \ No newline at end of file +The Control Panel can be deployed following the instructions in the Installation Guide. + +This product is a part of :doc:`NONRTRIC `.