Merge "DMAAP-MR - Merge MR repos"

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

diff --git a/docs/Installation/Installation.rst b/docs/Installation/Installation.rst
index f0095c5..53d9fd2 100644 (file)
--- a/docs/Installation/Installation.rst
+++ b/docs/Installation/Installation.rst
@@ -11,7 +11,7 @@ Message Router is developed using Kafka, Zookeeper and Java. AJSC framework is u
 Steps\r
 -----\r
 Message Router has 3 docker containers. Dmaap\_container,\r
-kafka\_contaienr and zookeeper\_container. Zookeeper runs on 172.18.0.2,\r
+kafka\_container and zookeeper\_container. Zookeeper runs on 172.18.0.2,\r
 kafka runs on 172.18.0.3 and dmaap on 172.18.0.4.\r
 \r
 1) Clone message service repo\r
@@ -60,4 +60,63 @@ 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.
\ No newline at end of file
+   you have subscribed to a topic.\r
+\r
+\r
+Steps for local development and test\r
+------------------------\r
+On Intel dev machine, in terminal (> indicates prompt) :\r
+1) Build kafka11aaf\r
+    > git clone https://gerrit.onap.org/r/dmaap/kafka\r
+    > cd kafka11aaf\r
+    > mvn clean install -Pdocker\r
+2) Build messageservice \r
+    > git clone https://gerrit.onap.org/r/dmaap/messagerouter/messageservice\r
+        - anonymous http, can't push changes\r
+    > cd messageservice\r
+    > mvn clean install -Pdocker\r
+3) Run tests \r
+    > cp bundleconfig-local/etc/appprops/MsgRtrApi.properties /var/tmp/\r
+        - edit /var/tmp/MsgRtrApi.properties\r
+            config.zk.servers=zookeeper\r
+            kafka.metadata.broker.list=kafka:9092\r
+            - docker-compose network maps service name(zookeeper, kafka) to IP\r
+        - set docker preferences/file sharing to access /var/tmp\r
+    > cd src/main/resources/docker-compose\r
+    - edit docker-compose.yml\r
+        - remove "nexus3.onap.org:10001/" from kafka and dmaap image names to \r
+            use local images\r
+    > docker-compose up -d\r
+    - create sample.txt file (as above)(content of file not important)\r
+    > curl -H "Content-Type:text/plain" -X POST -d @sample.txt http://localhost:3904/events/TestTopic1\r
+\r
+On Arm:\r
+1) Build kafka11aaf\r
+    > git clone https://gerrit.onap.org/r/dmaap/kafka\r
+    > cd kafka11aaf\r
+    > mvn clean install -Pdocker  -Ddocker.pull.registry=docker.io\r
+        - ensure we pull Arm version of base image\r
+2) Build messageservice \r
+    > git clone https://gerrit.onap.org/r/dmaap/messagerouter/messageservice\r
+        - anonymous http, can't push changes\r
+    > cd messageservice\r
+    > mvn clean install -Pdocker  -Ddocker.pull.registry=docker.io\r
+        - ensure we pull Arm version of base image\r
+3) Run tests \r
+    > cp bundleconfig-local/etc/appprops/MsgRtrApi.properties /var/tmp/\r
+        - edit /var/tmp/MsgRtrApi.properties\r
+            config.zk.servers=zookeeper\r
+            kafka.metadata.broker.list=kafka:9092\r
+            - docker-compose network maps service name(zookeeper, kafka) to IP\r
+        - set docker preferences/file sharing to access /var/tmp\r
+    > cd src/main/resources/docker-compose\r
+    - edit docker-compose.yml\r
+        - remove "nexus3.onap.org:10001/" from from kafka and dmaap image names to \r
+            use local images\r
+        - replace 'nexus3.onap.org:10001/onap/dmaap/zookeeper:1.0.0' with\r
+            multi-platform 'zookeeper'\r
+    > docker-compose up -d\r
+    - create sample.txt file (as above)(content of file not important)\r
+    > curl -H "Content-Type:text/plain" -X POST -d @sample.txt http://localhost:3904/events/TestTopic1\r
+\r
+   \r