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
   4 RIC Dashboard Overview
   5 ======================
   6
   7 The O-RAN SC RIC Dashboard provides administrative and operator
   8 functions for a radio access network (RAN) controller.  The web app is
   9 built as a single-page app using an Angular (version 8) front end and
  10 a Java (version 11) Spring-Boot (version 2.1) back end.
  11
  12 Project Resources
  13 -----------------
  14
  15 The source code is available from the Linux Foundation Gerrit server:
  16
  17     `<https://gerrit.o-ran-sc.org/r/portal/ric-dashboard;a=summary>`_
  18
  19 The build (CI) jobs are in the Linux Foundation Jenkins server:
  20
  21     `<https://jenkins.o-ran-sc.org/view/portal-ric-dashboard>`_
  22
  23 Issues are tracked in the Linux Foundation Jira server:
  24
  25     `<https://jira.o-ran-sc.org/secure/Dashboard.jspa>`_
  26
  27 Project information is available in the Linux Foundation Wiki:
  28
  29     `<https://wiki.o-ran-sc.org>`_
  30
  31
  32 A1 Mediator
  33 -----------
  34
  35 The Dashboard interfaces with the A1 Mediator.  This platform
  36 component is accessed via HTTP/REST requests using a client that is
  37 generated from an API specification published by the A1 Mediator team.
  38
  39 The A1 Mediator supports fetching and storing configuration of
  40 applications, which is referred to as getting or setting a policy.
  41 The Dashboard UI provides screens to view and modify configuration
  42 data for such applications.  As of this writing, the only application
  43 that is managed via the A1 Mediator interface is the Admission Control
  44 ("AC") application.
  45
  46
  47 Application Manager
  48 -------------------
  49
  50 The Dashboard interfaces with the Application 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 Application
  53 Manager team.
  54
  55 The Application Manager supports deploying, undeploying and
  56 configuring applications in the RIC. The Dashboard UI provides screens
  57 for these functions.
  58
  59
  60 Automatic Neighbor Relation Application
  61 ---------------------------------------
  62
  63 The Dashboard interfaces with the Automatic Neighbor Relation (ANR)
  64 application.  This RIC application is accessed via HTTP/REST requests
  65 using a client that is generated from an API specification published
  66 by the ANR team.
  67
  68 This RIC application discovers and manages the Neighbor Cell Relation
  69 Table (NCRT). The Dashboard UI provides screens to view and modify
  70 NCRT data.
  71
  72
  73 E2 Manager
  74 ----------
  75
  76 The Dashboard interfaces with the E2 Manager.  This platform
  77 component is accessed via HTTP/REST requests using a client that is
  78 generated from an API specification published by the E2 Manager team.
  79
  80 The E2 Manager platform component supports connecting and
  81 disconnecting RAN elements.  The Dashboard UI provides controls for
  82 operators to create "ENDC" and "X2" connections, and to disconnect RAN
  83 elements.