From: jyoak Date: Thu, 21 Nov 2019 06:57:14 +0000 (+0900) Subject: Docs merge with new template X-Git-Tag: 0.0.1~1 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=427d13693fe902e3c81c1b81425167626f2eaf28;p=ric-app%2Fkpimon.git Docs merge with new template Change-Id: Ica4fde8fb7ae590a0989e8cf6b071613593b6c61 Signed-off-by: jyoak --- diff --git a/docs/api-docs.rst b/docs/api-docs.rst deleted file mode 100644 index a09313d..0000000 --- a/docs/api-docs.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2019 YOUR-ORGANIZATION-NAME - - -API-Docs -======== - -This is the API-docs of - -.. contents:: - :depth: 3 - :local: - -.. note - -.. This section is used to describe a software API exposed from a O-RAN software component. - -.. This note must be removed after content has been added. - - -API Introduction ------------------ -.. Please add what API a component have exposed. - -API Functions -------------- -.. Please states the API functions. - diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst deleted file mode 100644 index 1764137..0000000 --- a/docs/developer-guide.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2019 YOUR-ORGANIZATION-NAME - - -Developer-Guide -=============== - -.. contents:: - :depth: 3 - :local: - -.. note: -.. * This section is used to describe what a contributor needs to know in order to work on the componenta - -.. * this should be very technical, aimed at people who want to help develop the components - -.. * this should be how the component does what it does, not a requirements document of what the component should do - -.. * this should contain what language(s) and frameworks are used, with versions - -.. * this should contain how to obtain the code, where to look at work items (Jira tickets), how to get started developing - -.. * This note must be removed after content has been added. - - -Processes ---------- - - - -Actions -------- - diff --git a/docs/index.rst b/docs/index.rst index a0f730e..6195ebb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,21 +1,17 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2019 YOUR-ORGANIZATION-NAME +.. Copyright (C) 2019 SAMSUNG -Welcome to O-RAN SC your_repo Documentation -=========================================== +Welcome to O-RAN SC KPI Monitoring Documentation +================================================ .. toctree:: :maxdepth: 2 :caption: Contents: overview.rst - developer-guide.rst release-notes.rst - installation-guide.rst - user-guide.rst - api-docs.rst diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst deleted file mode 100755 index c859cb0..0000000 --- a/docs/installation-guide.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2019 YOUR-ORGANIZATION-NAME - - -Installation Guide -================== - -.. contents:: - :depth: 3 - :local: - -Abstract --------- - -This document describes how to install , it's dependencies and required system resources. - - -Version history - -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 20XX-XX-XX | 0.1.0 | | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 1.0 | | | -| | | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ - - -Introduction ------------- - -.. - -.: - -This document describes the supported software and hardware configurations for the reference component as well as providing guidelines on how to install and configure such reference system. - -The audience of this document is assumed to have good knowledge in RAN network nd Linux system. - - -Preface -------- -.. - -: - -Before starting the installation of , some planning must preceed. - -.. note:any preperation you need before setting up sotfware and hardware - - -Hardware Requirements ---------------------- -.. - -: - -Following minimum hardware requirements must be met for installation of : - -+--------------------+----------------------------------------------------+ -| **HW Aspect** | **Requirement** | -| | | -+--------------------+----------------------------------------------------+ -| **# of servers** | | -+--------------------+----------------------------------------------------+ -| **CPU** | | -| | | -+--------------------+----------------------------------------------------+ -| **RAM** | | -| | | -+--------------------+----------------------------------------------------+ -| **Disk** | | -| | | -+--------------------+----------------------------------------------------+ -| **NICs** | | -| | | -| | | -| | | -| | | -| | | -+--------------------+----------------------------------------------------+ - - - -Software Installation and Deployment ------------------------------------- -.. - -: - -This section describes the installation of the installation on the reference hardware. - - - -References ----------- -.. - - - - diff --git a/docs/overview.rst b/docs/overview.rst index 0e979c6..707d61f 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,11 +1,13 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2019 YOUR-ORGANIZATION-NAME +.. Copyright (C) 2019 SAMSUNG -.. please write your project overview -.. please delete this comment after editing +KPI Monitoring Overview +======================= - -your_repo Overview -================== +LTE eNB and 5G NR gNB produce data that can be monitored and analyzed to measure the system's effectiveness. +The near Real-Time RIC can gather the radio and system Key Performance Indicators (KPI) from E2 Nodes and can utilize the metrics for closed-loop control. +The KPI includes but not limited following; UE measurement, E2 Node Measurement, E2 Node Load-related measurement. +The KPIMON xApp provides the first step towards the successful closed-loop control, through the monitoring E2 Node's performance metrics, and writing it into Redis DB. +With the near real-time reporting KPIs, the near Real-Time RIC can immediately control E2 Nodes. diff --git a/docs/release-notes.rst b/docs/release-notes.rst index afc1345..c14c16b 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2019 YOUR-ORGANIZATION-NAME +.. Copyright (C) 2019 SAMSUNG Release Notes @@ -21,13 +21,7 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 20XX-XX-XX | 0.1.0 | | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 1.0 | | | +| 2019-11-20 | 1.0.0 | Md Waseem Ahamed | First draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ @@ -35,91 +29,31 @@ Version history Summary ------- - - - +The Amber release of the KPI Mon xAPP supports full closed loop control +for CuCpResourceStatusReport from multiple gNBs +and stores the metrics in Redis DB. Release Data ------------ - - -: +--------------------------------------+--------------------------------------+ -| **Project** | E.g. project | +| **Project** | RAN Intelligent Controller | | | | +--------------------------------------+--------------------------------------+ -| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... | +| **Repo/commit-ID** | ric-app/kpimon | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | E.g. Arno RC2 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | E.g. 2015-04-16 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | | -| | | -+--------------------------------------+--------------------------------------+ - - - - -Feature Additions -^^^^^^^^^^^^^^^^^ - - -: - -**JIRA BACK-LOG:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | +| **Release designation** | Amber | | | | +--------------------------------------+--------------------------------------+ -| | | -| | | +| **Release date** | 2019-11-20 | | | | +--------------------------------------+--------------------------------------+ -| | | -| | | +| **Purpose of the delivery** | open-source xAPP for KPI Monitorin | | | | +--------------------------------------+--------------------------------------+ -Bug Corrections -^^^^^^^^^^^^^^^ - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ - -Deliverables -^^^^^^^^^^^^ - -Software Deliverables -+++++++++++++++++++++ - - - - - -Documentation Deliverables -++++++++++++++++++++++++++ - - - @@ -128,43 +62,8 @@ Known Limitations, Issues and Workarounds System Limitations ^^^^^^^^^^^^^^^^^^ - - - - -Known Issues -^^^^^^^^^^^^ - - -: - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ - -Workarounds -^^^^^^^^^^^ - - - - - - -References ----------- - - - +- The xAPP currently does not support A1 Interface, so policy updates is not implemented in the xAPP. All the GNB to be subscribed needs to be specified initially. +- The xAPP currently only supports messages from CU. +- The subscription request parameters (RAN Function ID etc) cannot be changed. diff --git a/docs/user-guide.rst b/docs/user-guide.rst deleted file mode 100755 index eb49ca7..0000000 --- a/docs/user-guide.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2019 YOUR-ORGANIZATION-NAME - - -User Guide -========== - -This is the user guide of OSC . - -.. contents:: - :depth: 3 - :local: - -.. a user guide should be how to use the component or system; it should not be a requirements document -.. delete this content after edittng it - - -Description ------------ -.. Describe the traget users of the projcet, for example, modeler/data scientist, ORAN-OSC platform admin, marketplace user, design studio end user, etc -.. Descirbe how the target users can get use of a O-RAN SC component. -.. If the guide contains sections on third-party tools, is it clearly stated why the O-RAN-OSC platform is using those tools? Are there instructions on how to install and configure each tool/toolset? - -Feature Introduction --------------------- -.. Provide enough information that a user will be able to operate the feature on a deployed scenario. content can be added from administration, management, using, Troubleshooting sections perspectives. - - - - -