Update content of README file

Update the README file to reflect the latest changes

SMO-31

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

diff --git a/Makefile b/Makefile
index bc792b1..53108ec 100755 (executable)
--- a/Makefile
+++ b/Makefile
@@ -1,24 +1,32 @@
-# Copyright 2021 Xoriant Corporation
-#
-# 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.
-#
-#
-default: all
-
-all:
-       cd agent; make
-       cd collector; make
-       cd kafka; make
-
-clean:
-       docker rm `docker ps -a -q -f status=exited`
+# Copyright 2021 Xoriant Corporation\r
+#\r
+# Licensed under the Apache License, Version 2.0 (the "License");\r
+# you may not use this file except in compliance with the License.\r
+# You may obtain a copy of the License at\r
+#\r
+# http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+# Unless required by applicable law or agreed to in writing, software\r
+# distributed under the License is distributed on an "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+# See the License for the specific language governing permissions and\r
+# limitations under the License.\r
+#\r
+#\r
+default: all\r
+\r
+all:\r
+       cd agent; make\r
+       cd collector; make\r
+       cd kafka; make\r
+       cd dmaapadapter; make\r
+       cd influxdb-connector; make\r
+\r
+run:\r
+       docker-compose up -d\r
+\r
+stop:\r
+       docker-compose down\r
+\r
+clean:\r
+       docker rm `docker ps -a -q -f status=exited`\r

diff --git a/README b/README
deleted file mode 100644 (file)
index 5a63a19..0000000
--- a/README
+++ /dev/null
@@ -1,36 +0,0 @@
-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 prerequisite to use this solution is that you need Docker
-running on the machine, where you want to run these containers.
-
-BUILD:
-
-To build the solution, you need to do the following in the collector
-folder.
-
-% make
-
-RUN:
-
-There are two scripts in this folder. A ves-start.sh script
-which starts the VES collector and other parts. A ves-stop.sh script
-can be used to stop the collector.
-
-
-Following steps are required for self-signed certificate.
- # Create ves-certificate directory on the host system using command "mkdir ~/ves-certificate".
- # 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
-
-**Note**: 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.
-

diff --git a/README.md b/README.md
new file mode 100755 (executable)
index 0000000..31dd0b5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# Introduction\r
+\r
+This repository supports the VES collector interface in O-RAN. It\r
+makes use of three containers, the ves-collector container that\r
+collects VES events posted by other parts of the O-RAN solution,\r
+Grafana, which is used to display measurement (PM) data posted\r
+by other entities and InfluxdB which is used to persist the data\r
+received by the collector.\r
+\r
+## Prerequisites:\r
+\r
+The prerequisite to use this solution is that you need Docker\r
+running on the machine, where you want to run these containers.\r
+\r
+## Build:\r
+\r
+To build the solution, you need to do the following in the current\r
+folder.\r
+\r
+    % make\r
+\r
+## Run:\r
+\r
+To run the solution, you need to invoke the following command\r
+\r
+    % docker-compose up -d ves-collector\r
+    % docker-compose up -d ves-agent\r
+\r
+or simply by the following make command\r
+\r
+    % make run\r
+\r
+To stop the solution the following command should be invoked.\r
+\r
+    % docker-compose down -d ves-collector\r
+    % docker-compose down -d ves-agent\r
+\r
+or simply by the following make command\r
+\r
+    % make stop\r
+\r
+## Certificates\r
+### Self-Signed Certificates\r
+Following steps are required for self-signed certificate.\r
+1. Create ves-certificate directory on the host system using command "mkdir ~/ves-certificate".\r
+2. Go to ves-certificate directory and use below commands to create self-signed certificate files.\r
+\r
+    openssl genrsa -out vescertificate.key 2048\r
+    openssl req -new -key vescertificate.key -out vescertificate.csr\r
+    openssl x509 -req -days 365 -in vescertificate.csr -signkey vescertificate.key -out vescertificate.crt\r
+### Third Party Certificates\r
+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.\r