Merge pull request #1 from waku-org/nwaku-interop-gowaku

Add support for gowaku

README.md

@@ -5,29 +5,31 @@
 * docker-compose
 
 ## How to run
-Without changing anything:
 
 ```
 git clone https://github.com/waku-org/waku-simulator.git
 cd waku-simulator
 ```
 
+Configure the simulation parameters. You can place the env variable in an `.env` file.
+
 ```
+export GOWAKU_IMAGE=statusteam/go-waku:v0.7.0
 export NWAKU_IMAGE=statusteam/nim-waku:v0.18.0-rc.0
 export NUM_NWAKU_NODES=5
+export NUM_GOWAKU_NODES=5
+export MSG_PER_SECOND=10
+export MSG_SIZE_KBYTES=10
 docker-compose up -d
 ```
 
 
 This will:
-* spin up grafana/prometheus for monitoring
-* spin up a bootstrap nwaku node
-* spin up NUM_NWAKU_NODES nwaku nodes
+* spin up grafana/prometheus for monitoring, see `http://localhost:3000`.
+* spin up a bootstrap nwaku node.
+* spin up a given amount of nwaku/gowaku nodes with specific versions.
 * spin up a `waku-publisher` instance that will inject traffic into the network (see flags for rate and msg size)
 
-Nodes can be monitored here:
-http://localhost:3000/d/yns_4vFVk/nwaku-monitoring?orgId=1
-
 
 ## warning
 

docker-compose.yml

@@ -30,25 +30,28 @@ services:
     depends_on:
       - bootstrap
 
-  #gowaku:
-  #  image: statusteam/go-waku:v0.7.0
-  #  restart: on-failure
-  #  deploy:
-  #    replicas: 5
-  #  entrypoint: sh
-  #  command:
-  #    - '/opt/run_gowaku.sh'
-  #  volumes:
-  #    - ./run_gowaku.sh:/opt/run_gowaku.sh:Z
-  #  depends_on:
-  #    - bootstrap
+  gowaku:
+    image: ${GOWAKU_IMAGE}
+    restart: on-failure
+    deploy:
+      replicas: ${NUM_GOWAKU_NODES}
+    entrypoint: sh
+    command:
+      - '/opt/run_gowaku.sh'
+    volumes:
+      - ./run_gowaku.sh:/opt/run_gowaku.sh:Z
+    depends_on:
+      - bootstrap
 
   waku-publisher:
-    image: alrevuelta/waku-publisher:c985cb3
+    image: alrevuelta/waku-publisher:de34e2d
     entrypoint: sh
       - 'opt/run_wakupublisher.sh'
     volumes:
       - ./run_wakupublisher.sh:/opt/run_wakupublisher.sh:Z
+    environment:
+      MSG_PER_SECOND: 10
+      MSG_SIZE_KBYTES: 10
 
   prometheus:
     image: prom/prometheus:latest

run_wakupublisher.sh

@@ -22,7 +22,7 @@ echo "Using bootstrap node: ${BOOTSTRAP_ENR}"
 exec /main\
     --pubsub-topic="/waku/2/default-waku/proto"\
     --content-topic="my-ctopic"\
-    --msg-per-second=10\
-    --msg-size-kb=1\
+    --msg-per-second=${MSG_PER_SECOND}\
+    --msg-size-kb=${MSG_SIZE_KBYTES}\
     --bootstrap-node=${BOOTSTRAP_ENR}\
     --max-peers=50