updated the documentation

[dmaap/messagerouter/messageservice.git] / docs / Installation / Installation.rst

diff --git a/docs/Installation/Installation.rst b/docs/Installation/Installation.rst
index 5232bd4..6912562 100644 (file)
--- a/docs/Installation/Installation.rst
+++ b/docs/Installation/Installation.rst
@@ -1,7 +1,15 @@
-=================================\r
-DMAAP MESSAGE ROUTER INSTALLATION\r
-=================================\r
-This document describes how to install and access DMaaP Message Router.\r
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+\r
+Installation\r
+============\r
+\r
+Environment\r
+-----------\r
+Message Router is developed using Kafka, Zookeeper and Java. AJSC framework is used to create the REST service and Docker was used to package the service.\r
+\r
+Steps\r
+-----\r
 Message Router has 3 docker containers. Dmaap\_container,\r
 kafka\_contaienr and zookeeper\_container. Zookeeper runs on 172.18.0.3,\r
 kafka runs on 172.18.0.2 and dmaap on 172.18.0.4.\r
@@ -17,9 +25,9 @@ kafka runs on 172.18.0.2 and dmaap on 172.18.0.4.
 3) In /var/tmp/MsgRtrApi.properties, change value of below variables as\r
    shown below:\r
 \r
-   config.zk.servers=172.18.0.3\r
+   config.zk.servers=172.18.0.3(Change as per where  ZooKeepeer is deployed)\r
 \r
-   kafka.metadata.broker.list=172.18.0.2:9092\r
+   kafka.metadata.broker.list=172.18.0.2:9092(Change as per where Kafka is deployed)\r
 \r
 4) Install docker and docker-compose\r
 \r
@@ -52,6 +60,4 @@ Testing
    http://172.18.0.4:3904/events/TestTopic1/CG1/C1?timeout=1000\r
 \r
    Note: You will only receive messages which have been published after\r
-   you have subscribed to a topic.\r
-\r
-\r
+   you have subscribed to a topic.
\ No newline at end of file