Prepare documentation for smo-ves project

SMO-71

Signed-off-by: santanude <santanu.de@xoriant.com>
Change-Id: I0a88ae1891ab764665cc99a1d596a9128a311a43
Signed-off-by: santanude <santanu.de@xoriant.com>

diff --git a/docs/api-docs.rst b/docs/api-docs.rst
deleted file mode 100644 (file)
index b7fde67..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.
-.. http://creativecommons.org/licenses/by/4.0
-
-
-
-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.
-

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
deleted file mode 100644 (file)
index 0d1f6e0..0000000
--- a/docs/developer-guide.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-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 09ba217..5856b72 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,11 +10,10 @@ Welcome to O-RAN SC smo/ves Documentation
    :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
index 2412acf..5a60a11 100644 (file)
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -13,7 +13,7 @@ Installation Guide
 Abstract
 --------
 
-This document describes how to install <Component>, it's dependencies and required system resources.
+This document describes how to install smo-ves, it's dependencies and required system resources.
 
 
 Version history
@@ -22,13 +22,13 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX         | 0.1.0              |                   | First draft        |
+| 2022-Aug-10        | 0.1.0              |  Santanu De        |  First draft       |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 0.1.1              |                    |                    |
+|                    |                    |                    |                    |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 1.0                |                    |                    |
+|                    |                    |                    |                    |
 |                    |                    |                    |                    |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
@@ -39,48 +39,44 @@ 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.
+The audience of this document is assumed to have good knowledge in RAN network, Ubuntu 20.04 LTS Desktop Edition system and Docker Compose.
 
 
 Preface
 -------
 .. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
 
-<EXAMPLE>:
-
-Before starting the installation of <project name>, some planning must preceed.
+Before starting the installation of smo-ves, make sure docker-compose, git are installed on the system
 
-.. note:any preperation you need before setting up sotfware and hardware 
+.. <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>:
+Following minimum hardware requirements must be met for installation of smo-ves:
 
 +--------------------+----------------------------------------------------+
 | **HW Aspect**      | **Requirement**                                    |
 |                    |                                                    |
 +--------------------+----------------------------------------------------+
-| **# of servers**   |                                                           |
+| **# of servers**   |         1                                                 |
 +--------------------+----------------------------------------------------+
-| **CPU**            |                                                           |
+| **CPU**            |         4 core                                            |
 |                    |                                                    |
 +--------------------+----------------------------------------------------+
-| **RAM**            |                                                           |
+| **RAM**            |         8 GB minimum, 16 GB recommended                   |
 |                    |                                                    |
 +--------------------+----------------------------------------------------+
-| **Disk**           |                                                           |
+| **Disk**           |         100 GB minimum, 500 GB recommended                |
 |                    |                                                    |
 +--------------------+----------------------------------------------------+
-| **NICs**           |                                                           |
+| **NICs**           |         1                                                 |
 |                    |                                                    |
 |                    |                                                           |
 |                    |                                                    |
@@ -94,16 +90,56 @@ 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 smo-ves installation on the reference hardware.
+
+Build
+~~~~~
+
+To build the solution, you need to do the following in the current folder::
+
+   % docker-compose build
+
+Run
+~~~
+
+To run the solution, you need to invoke the following command::
+
+    % docker-compose up -d
+
+
+To stop the solution the following command should be invoked::
+
+    % docker-compose down
+
+
+
+Following steps are required to install a certificate.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+   
+Self-Signed Certificates
+^^^^^^^^^^^^^^^^^^^^^^^^
+Following steps are required for self-signed certificate.
+1. Create ves-certificate directory on the host system using command "mkdir ~/ves-certificate".
+2. Go to ves-certificate directory and use below commands to create self-signed certificate files::
+
+    openssl genrsa -out vescertificate.key 2048
+    openssl req -new -key vescertificate.key -out vescertificate.csr
+    openssl x509 -req -days 365 -in vescertificate.csr -signkey vescertificate.key -out vescertificate.crt
 
-This section describes the installation of the <project name> installation on the reference hardware.
+Third Party Certificates
+^^^^^^^^^^^^^^^^^^^^^^^^
+Third party certificates can be installed by overwriting the file *vescertificate.csr*, *vescertificate.key*, and *vescertficate.crt* in ~/ves-certificate directory of the host system.
 
 
+Following steps are required to add an entry in the host file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Add following entry in host file on the computer from which user want to access Grafana  dashboard.
+<IP Address of VM/Machine on which docker containers are running> smo-influxdb
 
-References
-----------
-.. <PROVIDE NEEDED/USEFUL REFERENCES>
+For Example- Docker container running on the guest VM or different/remote machine having IP Address 192.168.56.110 then host file entry is as follows::
 
+    192.168.56.110 smo-influxdb
 
 
 

diff --git a/docs/overview.rst b/docs/overview.rst
index 390ad15..889f964 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -8,6 +8,6 @@ This project supports the O1/VES interface in SMO. It consists of several compon
 
 - A VES collector that is a collector of events posted by different Network Functions (NF) of the RAN
 - Kafka Bus which acts as the message bus in SMO
-- A connector to connect the Kafka Bus to a Grafana dashboard
 - A connector to connect the Kafka Bus to InfluxdB to persist all the data posted on the Kafka Bus
 - A connector that provides an adapter for applications that want to read the Kafka events as DMaaP events.
+- Grafana dashbaord which pull records from InfluxDB and display movements of matrix.

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index fd14a21..5b2a942 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -6,7 +6,7 @@ Release-Notes
 =============
 
 
-This document provides the release notes for <RELEASE> of <COMPONENT>.
+This document provides the release notes for F-RELEASE of semo-ves.
 
 .. contents::
    :depth: 3
@@ -20,7 +20,7 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2021-12-15         | 0.0.1              |                    | First version      |
+| 2022-07-15         | 5.0.1              |                    | First version      |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 |                    |                    |                    |                    |
@@ -34,7 +34,7 @@ Version history
 Summary
 -------
 
-This release provided several feature/capabilities for the O1/VES interface. It disaggregated the VES solution into several microservices that can scale independently. In addition, it added supoort for Network Slicing use case.
+The O1/VES interface received a number of features and capabilities in this edition. Adding functional test cases, integrating with the Jenkins server, saving container images in the Nexus repository, enhancing the quality of the code, implementing CLM and Sonar Jobs, etc.
 
 
 
@@ -42,16 +42,16 @@ Release Data
 ------------
 
 +--------------------------------------+--------------------------------------+
-| **Project**                          | SMO VES                             |
+| **Project**                          | SMO VES                             |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/commit-ID**                   | Repo: smo/ves                        |
-|                                      | Commit-Id:                           |
+| **Repo**                             | Repo: smo/ves                        |
+|                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | E-release                            |
+| **Release designation**              | f-release                            |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | 2021-12-15                           |
+| **Release date**                     | 2022-07-15                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | **Purpose of the delivery**          |                                     |
@@ -69,22 +69,32 @@ Feature Additions
 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| SMO-16                              | Add support for measurement event    |
+| SMO-57                              | Add Jenkins jobs for the smo repo    |
 |                                      |                                     |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| SMO-15                               | Add Kafka bus to SMO                |
-|                                      |                                     |
+| SMO-55                               | Add dmaap and influx-db adapter      |
+|                                      | plugins to the release process       |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| SMO-17                               | Add HTTPS support for VES events     |
+| SMO-53                               | Remove redundant code in smo        |
+|                                      | collector                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| SMO-68                               | Create CLM job for smo-ves project   |
 |                                      |                                     |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| SMO-18                               | Add support for DMaaP adapter        |
+| SMO-58                               | Add unit test cases in smo/ves       |
 |                                      |                                     |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
+| SMO-64                               | Add smo-post-config image to         |
+|                                      | the release process                 |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
 
 Bug Corrections
 ^^^^^^^^^^^^^^^
@@ -95,12 +105,8 @@ Bug Corrections
 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| SMO-19                              | VES Collector crashes after starting |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| SMO-14                               | Create docker-compose file          |
-|                                      |                                     |
+| SMO-63                              | Modify configuration of              |
+|                                      | Influxdb container                  |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -110,14 +116,13 @@ Deliverables
 Software Deliverables
 +++++++++++++++++++++
 
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
+Complied container images are available at Nexus repository https://nexus3.o-ran-sc.org/. Search with keyword 'smo'.
 
 
 Documentation Deliverables
 ++++++++++++++++++++++++++
 
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+Documentation is available at https://docs.o-ran-sc.org/projects/o-ran-sc-smo-ves/en/latest/release-notes.html
 
 
 
@@ -127,15 +132,13 @@ Known Limitations, Issues and Workarounds
 
 System Limitations
 ^^^^^^^^^^^^^^^^^^
-<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
+Not identified
 
 
 
 Known Issues
 ^^^^^^^^^^^^
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
 
-<EXAMPLE>:
 
 **JIRA TICKETS:**
 
@@ -144,7 +147,7 @@ Known Issues
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 |                                     |                                      |
-|                                      |                                     |
+|     SMO-74                           | Failure of Sonar job                |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 |                                     |                                      |
@@ -154,15 +157,8 @@ Known Issues
 
 Workarounds
 ^^^^^^^^^^^
+Working with the support team of the Linux Foundation to fix the problem.
 
-<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
-
-
-
-
-References
-----------
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
 
 
 

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 3c17a28..cb25743 100644 (file)
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -12,66 +12,22 @@ This is the user guide for OSC smo/ves
    :depth: 3
    :local:
    
-Introduction
-------------
-
-This repository supports the VES collector interface in O-RAN. It
-makes use of three containers, the ves-collector container that
-collects VES events posted by other parts of the O-RAN solution,
-Grafana, which is used to display measurement (PM) data posted
-by other entities and InfluxdB which is used to persist the data
-received by the collector.
-
-Prerequisites
--------------
-
-The prerequisites for using this solution are that you need Docker and docker-compose installed on the machine, where you want to run these containers.
-
-
-Build
------
-
-To build the solution, you need to do the following in the current folder.
-
-   % docker-compose build
-
-
-Run
----
-
-To run the solution, you need to invoke the following command::
-
-    % docker-compose up -d
-
-
-To stop the solution the following command should be invoked::
-
-    % docker-compose down
-
-
-
-Following steps are required to install a certificate.
-------------------------------------------------------
-Self-Signed Certificates
-~~~~~~~~~~~~~~~~~~~~~~~~
-Following steps are required for self-signed certificate.
-1. Create ves-certificate directory on the host system using command "mkdir ~/ves-certificate".
-2. Go to ves-certificate directory and use below commands to create self-signed certificate files::
-
-    openssl genrsa -out vescertificate.key 2048
-    openssl req -new -key vescertificate.key -out vescertificate.csr
-    openssl x509 -req -days 365 -in vescertificate.csr -signkey vescertificate.key -out vescertificate.crt
-
-Third Party Certificates
-~~~~~~~~~~~~~~~~~~~~~~~~
-Third party certificates can be installed by overwriting the file *vescertificate.csr*, *vescertificate.key*, and *vescertficate.crt* in ~/ves-certificate directory of the host system.
-
-
-Following steps are required to add an entry in the host file
--------------------------------------------------------------
-Add following entry in host file on the computer from which user want to access Grafana  dashboard.
-<IP Address of VM/Machine on which docker containers are running> smo-influxdb
-
-For Example- Docker container running on the guest VM or different/remote machine having IP Address 192.168.56.110 then host file entry is as follows::
-
-    192.168.56.110 smo-influxdb
+Check Containers  
+----------------
+Run the below command to status of the containers. All contaiers should be is "Up" state except "smo-post-config"::
+
+ % docker-compose ps
+ 
+Check SMO-Collector API
+-----------------------
+Launch a browser and navigate to [IP Address of VM/Machine on which docker containers are running]:9999/v7/events/. SMO-Collector runs on https
+ 
+ 
+Check DMAAP API
+---------------
+Launch a browser and navigate to [IP Address of VM/Machine on which docker containers are running]:5000/dmaapapi/v1/topics
+ 
+
+Check Grafana Dashborad
+-----------------------
+Open [IP Address of VM/Machine on which docker containers are running]:3000/ in a browser. admin/admin is default username/password. No need to reset password. After login, visit Dashborads > Manage section. "Events Demo" Dashbaord is ready to use.