Yet more documentation updates
[portal/nonrtric-controlpanel.git] / docs / overview.rst
index e2040ac..4e168b2 100644 (file)
@@ -1,24 +1,31 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2021 Nordix
 
+Non-RT RIC Control Panel Overview
+=================================
 
-Controlpanel Overview
-=====================
+Graphical user interface with the following capabilities:
 
-The Non-RT RIC Controlpanel is a graphical user  user interface that enables the user to manage the Policies in the
-network. The Controlpanel interacts with the Policy agent via a REST API.
-The Controlpanel generates its GUI from JSON schemas in a model driven fashion.
+*  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 Controlpanel consists of a back end implemented as a Java Spring Boot application and a fronted developed using the
-Angular framework.
+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.
 
-Controlpanel architecture
--------------------------
+.. note::
+   It is fully supported in Firefox and Chrome. Minor issues in Safari.
+   Not supported in Microsoft Edge and IE.
 
-The architecture of the Controlpanel is as shown on the following picture:
+Control Panel architecture
+--------------------------
 
-.. image:: ./images/architecture.png
+The architecture of the Control Panel is as shown on the following picture:
+
+.. image:: ./images/ControlPanel_architecture.png
    :scale: 50 %
 
-The Controlpanel 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.