docs/overview.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2019 AT&T Intellectual Property
   4
   5 RIC Dashboard Overview
   6 ======================
   7
   8 The O-RAN SC RIC Dashboard provides administrative and operator
   9 functions for a radio access network (RAN) controller.  The web app is
  10 built as a single-page app using an Angular (version 8) front end and
  11 a Java (version 11) Spring-Boot (version 2.1) back end.
  12
  13 Project Resources
  14 -----------------
  15
  16 The project uses the following Linux Foundation resources.
  17
  18 * The source code is maintained in this Gerrit:
  19     `<https://gerrit.o-ran-sc.org/r/admin/repos/portal/ric-dashboard>`_
  20 * The build (CI) jobs are in this Jenkins:
  21     `<https://jenkins.o-ran-sc.org/view/portal-ric-dashboard>`_
  22 * Issues are tracked in this Jira:
  23     `<https://jira.o-ran-sc.org/issues/?jql=project%3DOAM%20AND%20component%3D%22portal%2Fric-dashboard%22>`_
  24 * Project information is available in this Wiki:
  25     `<https://wiki.o-ran-sc.org/display/OAM/RIC+Dashboard+Application>`_
  26
  27
  28 Managed Resources
  29 -----------------
  30
  31 The RIC Dashboard is used to manage the following RIC Platform and RIC
  32 xApplication components.
  33
  34 Application Manager
  35 ~~~~~~~~~~~~~~~~~~~
  36
  37 The Dashboard interfaces with the Application Manager.  This platform
  38 component is accessed via HTTP/REST requests using a client that is
  39 generated from an API specification published by the Application
  40 Manager team.
  41
  42 The Application Manager supports deploying, undeploying and
  43 configuring applications in the RIC. The Dashboard UI provides screens
  44 for these functions.
  45
  46
  47 E2 Manager
  48 ~~~~~~~~~~
  49
  50 The Dashboard interfaces with the E2 Manager.  This platform
  51 component is accessed via HTTP/REST requests using a client that is
  52 generated from an API specification published by the E2 Manager team.
  53
  54 The E2 Manager platform component supports connecting and
  55 disconnecting RAN elements.  The Dashboard UI provides controls for
  56 operators to create "ENDC" and "X2" connections, and to disconnect RAN
  57 elements.