Add user guide with screen shots.
Change-Id: Id21363b9d8d09312b9d7821a29ce9d46c01ae79e
Issue-ID: OAM-102
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
The properties are listed below in alphabetical order.
-``a1med.url.prefix``
-
-A1 Mediator URL prefix. No useful default. Usually a service name
-like ``http://ricplt-entry/a1mediator``
-
-``a1med.url.suffix``
-
-A1 Mediator URL suffix. Default is the empty string.
-
``appmgr.url.prefix``
Application Manager URL prefix. No useful default. Usually a service
REST user name expected at ONAP portal. No default value.
+``ricinstances.regions``
+
+List of RIC region entries. Each region has a name and a list of RIC
+instances. See the application.yaml file for an example.
+
``server.port``
Port where the Tomcat server listens for requests. Default is ``8080``.
-``metrics.url.ac``
+``statsfile``
-Url to the kibana source which visualizes AC App metrics. No default value and needs to be replaced with actual value during deployment time.
+Path of file that stores application statistic details. Default is ``dashboard-stats.json``.
``userfile``
-Path of file that stores user details. Default is ``users.json``.
+Path of file that stores user details. Default is ``dashboard-users.json``.
Key Properties
appropriately, launch the server with this command-line invocation to
include the ``config`` directory on the Java classpath::
- java -cp config:target/ric-dash-be-1.2.0-SNAPSHOT.jar \
+ java -cp config:target/ric-dash-be-2.0.1-SNAPSHOT.jar \
-Dloader.main=org.oransc.ric.portal.dashboard.DashboardApplication \
org.springframework.boot.loader.PropertiesLauncher
RIC Dashboard Developer Guide
=============================
-This document provides a quickstart for developers of the O-RAN SC RIC Dashboard web
-application.
+This document provides a quickstart for developers of the O-RAN SC RIC
+Dashboard web application.
Prerequisites
-------------
1. Java development kit (JDK), version 11 or later
2. Maven dependency-management tool, version 3.4 or later
-Other required tools including the Node Package Manager (npm) are fetched dynamically.
+Other required tools including the Node Package Manager (npm) are
+fetched dynamically.
Clone and Update Submodules
---------------------------
-After cloning the repository, initialize and update all git submodules like this::
+After cloning the repository, initialize and update all git submodules
+like this::
git submodule init
git submodule update
Angular Front-End Application
-----------------------------
-The Angular 8 application files are in subdirectory ``webapp-frontend``.
-Build the front-end application via ``mvn package``. For development and debugging,
-build the application, then launch an ng development server using this command::
+The Angular 8 application files are in subdirectory
+``webapp-frontend``. Build the front-end application via ``mvn
+package``. For development and debugging, build the application, then
+launch an ng development server using this command::
./ng serve --proxy-config proxy.conf.json
-The app will automatically reload in the browser if you change any of the source files.
-The ng server listens for requests at this URL:
+The app will automatically reload in the browser if you change any of
+the source files. The ng server listens for requests at this URL:
http://localhost:4200
Spring-Boot Back-End Application
--------------------------------
-A development (not production) server uses local configuration and serves mock data
-that simulates the behavior of remote endpoints. The back-end server listens for
-requests at this URL:
+A development (not production) server uses local configuration and
+serves mock data that simulates the behavior of remote endpoints. The
+back-end server listens for requests at this URL:
http://localhost:8080
-The directory ``src/test/resources`` contains usable versions of the required property
-files. These steps are required to launch:
+The directory ``src/test/resources`` contains usable versions of the
+required property files. These steps are required to launch:
1. Install all project jar files locally
2. Set an environment variable via JVM argument: ``-Dorg.oransc.ric.portal.dashboard=mock``
Development user authentication
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The development server requires basic HTTP user authentication for all requests. Like
-the production server, it requires HTTP headers with authentication for Portal API
-requests. The username and password are stored in constants in this Java class in
-the ``src/test/java`` folder::
+The development server requires basic HTTP user authentication for all
+requests. Like the production server, it requires HTTP headers with
+authentication for Portal API requests. The username and password are
+stored in constants in this Java class in the ``src/test/java``
+folder::
org.oransc.ric.portal.dashboard.config.WebSecurityMockConfiguration
-Like the production server, the development server also performs role-based
-authentication on requests. The user name-role name associations are also defined
-in the class shown above.
+Like the production server, the development server also performs
+role-based authentication on requests. The user name-role name
+associations are also defined in the class shown above.
Production user authentication
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The server uses the ONAP Portal's "EPSDK-FW" library to support a
-single-sign-on (SSO) feature, which requires users to authenticate
-at the ONAP Portal UI. The RIC Dashboard can be on-boarded as an
+single-sign-on (SSO) feature, which requires users to authenticate at
+the ONAP Portal UI. The RIC Dashboard can be on-boarded as an
application on the ONAP Portal using its application on-boarding UI.
The server authenticates requests using cookies that are set
That ID must match a user's loginId defined in the user manager.
The regular server checks requests for the following granted
-authorities (role names), as defined in the java class ``DashboardConstants``.
-A standard user can invoke all "GET" methods but not make changes.
-A system administrator can invoke all methods ("GET", "POST", "PUT",
-"DELETE") to make arbitrary changes::
+authorities (role names), as defined in the java class
+``DashboardConstants``. A standard user can invoke all "GET" methods
+but not make changes. A system administrator can invoke all methods
+("GET", "POST", "PUT", "DELETE") to make arbitrary changes::
Standard_User
System_Administrator
overview.rst
config-deploy.rst
developer-guide.rst
+ user-guide.rst
release-notes.rst
* :ref:`search`
Project Resources
-----------------
-The source code is available from the Linux Foundation Gerrit server:
-
- `<https://gerrit.o-ran-sc.org/r/portal/ric-dashboard;a=summary>`_
-
-The build (CI) jobs are in the Linux Foundation Jenkins server:
+The project uses the following Linux Foundation resources.
+* The source code is maintained in this Gerrit:
+ `<https://gerrit.o-ran-sc.org/r/admin/repos/portal/ric-dashboard>`_
+* The build (CI) jobs are in this Jenkins:
`<https://jenkins.o-ran-sc.org/view/portal-ric-dashboard>`_
+* Issues are tracked in this Jira:
+ `<https://jira.o-ran-sc.org/issues/?jql=project%3DOAM%20AND%20component%3D%22portal%2Fric-dashboard%22>`_
+* Project information is available in this Wiki:
+ `<https://wiki.o-ran-sc.org/display/OAM/RIC+Dashboard+Application>`_
-Issues are tracked in the Linux Foundation Jira server:
-
- `<https://jira.o-ran-sc.org/secure/Dashboard.jspa>`_
-
-Project information is available in the Linux Foundation Wiki:
-
- `<https://wiki.o-ran-sc.org>`_
+Managed Resources
+-----------------
-A1 Mediator
------------
-
-The Dashboard interfaces with the A1 Mediator. This platform
-component is accessed via HTTP/REST requests using a client that is
-generated from an API specification published by the A1 Mediator team.
-
-The A1 Mediator supports fetching and storing configuration of
-applications, which is referred to as getting or setting a policy.
-The Dashboard UI provides screens to view and modify configuration
-data for such applications. As of this writing, the only application
-that is managed via the A1 Mediator interface is the Admission Control
-("AC") application.
-
+The RIC Dashboard is used to manage the following RIC Platform and RIC
+xApplication components.
Application Manager
--------------------
+~~~~~~~~~~~~~~~~~~~
The Dashboard interfaces with the Application Manager. This platform
component is accessed via HTTP/REST requests using a client that is
E2 Manager
-----------
+~~~~~~~~~~
The Dashboard interfaces with the E2 Manager. This platform
component is accessed via HTTP/REST requests using a client that is
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2020 AT&T Intellectual Property
+
+RIC Dashboard User Guide
+========================
+
+This document provides a quickstart for users of the O-RAN SC RIC
+Dashboard web application.
+
+
+Main Page
+---------
+
+The main (home) page has tiles for catalog, control and application
+statistics, which are the main three areas of the Dashboard. A screen
+shot of the main page is shown below.
+
+.. image:: _static/dashboard-v2-main.png
+
+
+Left Menu
+---------
+
+Items on the left menu give access to all features of the RIC
+Dashboard A screen shot of the menu is shown below.
+
+.. image:: _static/dashboard-v2-menu.png
+
+
+xRIC Instances
+--------------
+
+The Dashboard can be configured to manage multiple RIC instances.
+Instances are grouped into regions. Users can select the instance to
+manage by clicking on the button shown at the bottom right of the main
+page, which brings up the dialog shown below.
+
+.. image:: _static/dashboard-v2-instance.png
+
+
+xApp Catalog
+------------
+
+The catalog page shows all the applications that can be deployed to
+the RIC. Users may change static settings or deploy an application
+form this page. A sample screen shot is shown below.
+
+.. image:: _static/dashboard-v2-catalog.png
+
+
+RIC Control
+-----------
+
+The control page shows the current RAN connections and the
+applications deployed to the RIC. Users may disconnect the RIC, adjust
+dynamic application settings and undeploy applications. A sample
+screen shot is shown below.
+
+.. image:: _static/dashboard-v2-control.png
+
+
+Platform Status
+---------------
+
+The cluster pods view shows the Kubernetes pod details. A sample
+screen shot is shown below.
+
+.. image:: _static/dashboard-v2-pods.png
+
+
+Platform Statistic Views
+------------------------
+
+The stats page allows configuration of views that analyze and display
+statistics gathered by a remote system for applications deployed to
+the RIC. Users may add or remove views. A sample screen shot is shown
+below.
+
+.. image:: _static/dashboard-v2-platform-stats.png
Code Review / portal / ric-dashboard.git / commitdiff
