X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Foverview.rst;h=d95f7c374b23f4869f10f4401a928a2d7d5fd836;hb=119e1207ab3dd53fe2b868c3a8f671cadde0c531;hp=21029052f7a627a3fe888b516d46c41f612a435b;hpb=0f3312b36f849df0e1671c333e0072aca3a1acf6;p=portal%2Fric-dashboard.git diff --git a/docs/overview.rst b/docs/overview.rst index 21029052..d95f7c37 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,25 +1,57 @@ -.. ===============LICENSE_START======================================================= -.. O-RAN SC CC-BY-4.0 -.. %% -.. Copyright (C) 2019 AT&T Intellectual Property and Nokia -.. %% -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. ===============LICENSE_END========================================================= +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2019 AT&T Intellectual Property -====================== RIC Dashboard Overview ====================== -The O-RAN SC RIC Dashboard provides administrative and operator functions. -The web app is built as a single-page app using an Angular front end and a -Java Spring-Boot back end. +The O-RAN SC RIC Dashboard provides administrative and operator +functions for a radio access network (RAN) controller. The web app is +built as a single-page app using an Angular (version 8) front end and +a Java (version 11) Spring-Boot (version 2.1) back end. + +Project Resources +----------------- + +The project uses the following Linux Foundation resources. + +* The source code is maintained in this Gerrit: + ``_ +* The build (CI) jobs are in this Jenkins: + ``_ +* Issues are tracked in this Jira: + ``_ +* Project information is available in this Wiki: + ``_ + + +Managed Resources +----------------- + +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 +generated from an API specification published by the Application +Manager team. + +The Application Manager supports deploying, undeploying and +configuring applications in the RIC. The Dashboard UI provides screens +for these functions. + + +E2 Manager +~~~~~~~~~~ + +The Dashboard interfaces with the E2 Manager. This platform +component is accessed via HTTP/REST requests using a client that is +generated from an API specification published by the E2 Manager team. + +The E2 Manager platform component supports connecting and +disconnecting RAN elements. The Dashboard UI provides controls for +operators to create "ENDC" and "X2" connections, and to disconnect RAN +elements.