docs/overview.rst

   1 .. ===============LICENSE_START=======================================================
   2 .. O-RAN SC CC-BY-4.0
   3 .. %%
   4 .. Copyright (C) 2019 AT&T Intellectual Property
   5 .. %%
   6 .. Licensed under the Apache License, Version 2.0 (the "License");
   7 .. you may not use this file except in compliance with the License.
   8 .. You may obtain a copy of the License at
   9 ..
  10 ..      http://www.apache.org/licenses/LICENSE-2.0
  11 ..
  12 .. Unless required by applicable law or agreed to in writing, software
  13 .. distributed under the License is distributed on an "AS IS" BASIS,
  14 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 .. See the License for the specific language governing permissions and
  16 .. limitations under the License.
  17 .. ===============LICENSE_END=========================================================
  18
  19 RIC Dashboard Overview
  20 ======================
  21
  22 The O-RAN SC RIC Dashboard provides administrative and operator
  23 functions for a radio access network (RAN) controller.  The web app is
  24 built as a single-page app using an Angular (version 8) front end and
  25 a Java (version 11) Spring-Boot (version 2.1) back end.
  26
  27 Project Resources
  28 -----------------
  29
  30 The source code is available from the Linux Foundation Gerrit server:
  31
  32     `<https://gerrit.o-ran-sc.org/r/portal/ric-dashboard;a=summary>`_
  33
  34 The build (CI) jobs are in the Linux Foundation Jenkins server:
  35
  36     `<https://jenkins.o-ran-sc.org/view/portal-ric-dashboard>`_
  37
  38 Issues are tracked in the Linux Foundation Jira server:
  39
  40     `<https://jira.o-ran-sc.org/secure/Dashboard.jspa>`_
  41
  42 Project information is available in the Linux Foundation Wiki:
  43
  44     `<https://wiki.o-ran-sc.org>`_
  45
  46
  47 A1 Mediator
  48 -----------
  49
  50 The Dashboard interfaces with the A1 Mediator.  This platform
  51 component is accessed via HTTP/REST requests using a client that is
  52 generated from an API specification published by the A1 Mediator team.
  53
  54 The A1 Mediator supports fetching and storing configuration of
  55 applications, which is referred to as getting or setting a policy.
  56 The Dashboard UI provides screens to view and modify configuration
  57 data for such applications.  As of this writing, the only application
  58 that is managed via the A1 Mediator interface is the Admission Control
  59 ("AC") application.
  60
  61
  62 Application Manager
  63 -------------------
  64
  65 The Dashboard interfaces with the Application Manager.  This platform
  66 component is accessed via HTTP/REST requests using a client that is
  67 generated from an API specification published by the Application
  68 Manager team.
  69
  70 The Application Manager supports deploying, undeploying and
  71 configuring applications in the RIC. The Dashboard UI provides screens
  72 for these functions.
  73
  74
  75 Automatic Neighbor Relation Application
  76 ---------------------------------------
  77
  78 The Dashboard interfaces with the Automatic Neighbor Relation (ANR)
  79 application.  This RIC application is accessed via HTTP/REST requests
  80 using a client that is generated from an API specification published
  81 by the ANR team.
  82
  83 This RIC application discovers and manages the Neighbor Cell Relation
  84 Table (NCRT). The Dashboard UI provides screens to view and modify
  85 NCRT data.
  86
  87
  88 E2 Manager
  89 ----------
  90
  91 The Dashboard interfaces with the E2 Manager.  This platform
  92 component is accessed via HTTP/REST requests using a client that is
  93 generated from an API specification published by the E2 Manager team.
  94
  95 The E2 Manager platform component supports connecting and
  96 disconnecting RAN elements.  The Dashboard UI provides controls for
  97 operators to create "ENDC" and "X2" connections, and to disconnect RAN
  98 elements.