X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Foverview.rst;h=d95f7c374b23f4869f10f4401a928a2d7d5fd836;hb=refs%2Fchanges%2F83%2F4183%2F2;hp=a58986e0fcebec2e8ad3b6a8ac4f2cf21248b6c3;hpb=4f8259dcd4597a7c96285907bd33941d44ac456a;p=portal%2Fric-dashboard.git diff --git a/docs/overview.rst b/docs/overview.rst index a58986e0..d95f7c37 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,20 +1,6 @@ -.. ===============LICENSE_START======================================================= -.. O-RAN SC CC-BY-4.0 -.. %% +.. 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 -.. %% -.. 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========================================================= RIC Dashboard Overview ====================== @@ -27,40 +13,26 @@ a Java (version 11) Spring-Boot (version 2.1) back end. Project Resources ----------------- -The source code is available from the Linux Foundation Gerrit server: - - ``_ - -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: + ``_ +* The build (CI) jobs are in this Jenkins: ``_ +* Issues are tracked in this Jira: + ``_ +* Project information is available in this Wiki: + ``_ -Issues are tracked in the Linux Foundation Jira server: - - ``_ - -Project information is available in the Linux Foundation Wiki: - - ``_ - - -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. +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 @@ -72,21 +44,8 @@ configuring applications in the RIC. The Dashboard UI provides screens for these functions. -Automatic Neighbor Relation Application ---------------------------------------- - -The Dashboard interfaces with the Automatic Neighbor Relation (ANR) -application. This RIC application is accessed via HTTP/REST requests -using a client that is generated from an API specification published -by the ANR team. - -This RIC application discovers and manages the Neighbor Cell Relation -Table (NCRT). The Dashboard UI provides screens to view and modify -NCRT data. - - E2 Manager ----------- +~~~~~~~~~~ The Dashboard interfaces with the E2 Manager. This platform component is accessed via HTTP/REST requests using a client that is