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