+++ /dev/null
-.. 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 <COMPONENT>
-
-.. 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.
-
+++ /dev/null
-.. 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
--------
-
.. 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
+++ /dev/null
-.. 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 <Component>, 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
-------------
-
-.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
-
-.<EXAMPLE>:
-
-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
--------
-.. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
-
-<EXAMPLE>:
-
-Before starting the installation of <project name>, some planning must preceed.
-
-.. note:any preperation you need before setting up sotfware and hardware
-
-
-Hardware Requirements
----------------------
-.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
-
-<EXAMPLE>:
-
-Following minimum hardware requirements must be met for installation of <project name>:
-
-+--------------------+----------------------------------------------------+
-| **HW Aspect** | **Requirement** |
-| | |
-+--------------------+----------------------------------------------------+
-| **# of servers** | |
-+--------------------+----------------------------------------------------+
-| **CPU** | |
-| | |
-+--------------------+----------------------------------------------------+
-| **RAM** | |
-| | |
-+--------------------+----------------------------------------------------+
-| **Disk** | |
-| | |
-+--------------------+----------------------------------------------------+
-| **NICs** | |
-| | |
-| | |
-| | |
-| | |
-| | |
-+--------------------+----------------------------------------------------+
-
-
-
-Software Installation and Deployment
-------------------------------------
-.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
-
-<EXAMPLE>:
-
-This section describes the installation of the <project name> installation on the reference hardware.
-
-
-
-References
-----------
-.. <PROVIDE NEEDED/USEFUL REFERENCES>
-
-
-
-
.. 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.
.. 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
| **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 |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
Summary
-------
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
-
-
+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
------------
-<STATE RELEVANT RELEASE DATA/RECORDS>
-
-<EXAMPLE>:
+--------------------------------------+--------------------------------------+
-| **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
-^^^^^^^^^^^^^^^^^
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
-
-<EXAMPLE>:
-
-**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
-+++++++++++++++++++++
-
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
-
-
-Documentation Deliverables
-++++++++++++++++++++++++++
-
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
System Limitations
^^^^^^^^^^^^^^^^^^
-<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
-
-
-
-Known Issues
-^^^^^^^^^^^^
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
-
-<EXAMPLE>:
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-
-Workarounds
-^^^^^^^^^^^
-
-<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
-
-
-
-
-References
-----------
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
-
-
+- 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.
+++ /dev/null
-.. 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 <COMPONENT>.
-
-.. 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.
-
-
-
-
-
Code Review / ric-app / kpimon.git / commitdiff