Content in README.md missing after merge
Update content of README.md, docs/overview.rst, docs/user-guide.rst files
SMO-37
Signed-off-by: santanude <santanu.de@xoriant.com>
Change-Id: Ib2585a367acf5c5545c7f1c0bcb450b861494c7b
Signed-off-by: santanude <santanu.de@xoriant.com>
diff --git a/README.md b/README.md
index 31dd0b5..bf87f4b 100755
--- a/README.md
+++ b/README.md
@@ -9,8 +9,8 @@
## Prerequisites:
-The prerequisite to use this solution is that you need Docker
-running on the machine, where you want to run these containers.
+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:
@@ -39,7 +39,9 @@
% make stop
-## Certificates
+******************************************************************************************************
+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".
@@ -50,3 +52,14 @@
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
+
diff --git a/docs/overview.rst b/docs/overview.rst
index 6d620a1..6a3b541 100644
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -1,10 +1,74 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
+smo/ves Overview
+================
-..please write your project overview
-..please delete this content after editing
+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::
+
+ % make
+
+Run:
+
+To run the solution, you need to invoke the following command::
+
+ % docker-compose up -d ves-collector
+ % docker-compose up -d ves-agent
+
+or simply by the following make command::
+
+ % make run
+
+To stop the solution the following command should be invoked::
+
+ % docker-compose down -d ves-collector
+ % docker-compose down -d ves-agent
+
+or simply by the following make command::
+
+ % make stop
-your_repo Overview
-======================
+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
+
diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 989f319..b7874e5 100644
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -6,27 +6,76 @@
User Guide
==========
-This is the user guide of OSC <COMPONENT>.
+This is the user guide for OSC smo/ves
.. contents::
:depth: 3
:local:
+
+Introduction
-.. 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
+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::
+
+ % make
+
+Run:
+
+To run the solution, you need to invoke the following command::
+
+ % docker-compose up -d ves-collector
+ % docker-compose up -d ves-agent
+
+or simply by the following make command::
+
+ % make run
+
+To stop the solution the following command should be invoked::
+
+ % docker-compose down -d ves-collector
+ % docker-compose down -d ves-agent
+
+or simply by the following make command::
+
+ % make stop
-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?
+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::
-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.
-
-
-
+ 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