docs/user-guide.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) 2020 AT&T Intellectual Property
   4
   5 RIC Dashboard User Guide
   6 ========================
   7
   8 This document provides a quickstart for users of the O-RAN SC RIC
   9 Dashboard web application.
  10
  11
  12 Main Page
  13 ---------
  14
  15 The main (home) page has tiles for catalog, control and application
  16 statistics, which are the main three areas of the Dashboard. A screen
  17 shot of the main page is shown below.
  18
  19 .. image:: _static/dashboard-v2-main.png
  20
  21
  22 Left Menu
  23 ---------
  24
  25 Items on the left menu give access to all features of the RIC
  26 Dashboard A screen shot of the menu is shown below.
  27
  28 .. image:: _static/dashboard-v2-menu.png
  29
  30
  31 xRIC Instances
  32 --------------
  33
  34 The Dashboard can be configured to manage multiple RIC instances.
  35 Instances are grouped into regions.  Users can select the instance to
  36 manage by clicking on the button shown at the bottom right of the main
  37 page, which brings up the dialog shown below.
  38
  39 .. image:: _static/dashboard-v2-instance.png
  40
  41
  42 xApp Catalog
  43 ------------
  44
  45 The catalog page shows all the applications that can be deployed to
  46 the RIC.  Users may change static settings or deploy an application
  47 form this page.  A sample screen shot is shown below.
  48
  49 .. image:: _static/dashboard-v2-catalog.png
  50
  51
  52 RIC Control
  53 -----------
  54
  55 The control page shows the current RAN connections and the
  56 applications deployed to the RIC. Users may disconnect the RIC, adjust
  57 dynamic application settings and undeploy applications.  A sample
  58 screen shot is shown below.
  59
  60 .. image:: _static/dashboard-v2-control.png
  61
  62
  63 Platform Status
  64 ---------------
  65
  66 The cluster pods view shows the Kubernetes pod details. A sample
  67 screen shot is shown below.
  68
  69 .. image:: _static/dashboard-v2-pods.png
  70
  71
  72 Platform Statistic Views
  73 ------------------------
  74
  75 The stats page allows configuration of views that analyze and display
  76 statistics gathered by a remote system for applications deployed to
  77 the RIC. Users may add or remove views.  A sample screen shot is shown
  78 below.
  79
  80 .. image:: _static/dashboard-v2-platform-stats.png