automates one observer in-docker setup

Signed-off-by: Andrey Kononykhin <andkononykhin@gmail.com>

Author: andkononykhin

Makefile

@@ -57,7 +57,11 @@ localnet_init:
 	/bin/bash ./genlocalnetconfig.sh
 
 localnet_start:
-	docker-compose up -d
+	@if [ -d "localnet/observer0" ]; then\
+		docker-compose --profile observers up -d;\
+	else\
+		docker-compose up -d;\
+	fi
 
 localnet_stop:
 	docker-compose down
@@ -67,13 +71,19 @@ localnet_export: localnet_stop
 	docker-compose run node1 dcld export --for-zero-height  >genesis.export.node1.json
 	docker-compose run node2 dcld export --for-zero-height  >genesis.export.node2.json
 	docker-compose run node3 dcld export --for-zero-height  >genesis.export.node3.json
+	@if [ -d "localnet/observer0" ]; then\
+		docker-compose run observer0 dcld export --for-zero-height  >genesis.export.observer0.json;\
+	fi
 
 
 localnet_reset: localnet_stop
 	docker-compose run node0 dcld unsafe-reset-all
 	docker-compose run node1 dcld unsafe-reset-all
 	docker-compose run node2 dcld unsafe-reset-all
 	docker-compose run node3 dcld unsafe-reset-all
+	@if [ -d "localnet/observer0" ]; then\
+		docker-compose run observer0 dcld unsafe-reset-all;\
+	fi
 
 localnet_clean: localnet_stop
 	rm -rf $(LOCALNET_DIR)

README-DEV.md

@@ -51,7 +51,10 @@ It's recommended to develop and deploy the App on Ubuntu 18.04 or Ubuntu 20.04.
 The easiest way to run a local pool is to start it in Docker:
 
     make install
+
+    # DCL_OBSERVERS=1 make localnet_init  # to initialize observers as well
     make localnet_init
+
     make localnet_start
 
 This will start a local pool of 4 validator nodes in Docker. The nodes will expose their RPC enpoints on ports `26657`, `26659`, `26661`, `26663` correspondingly.

bench/README.md

@@ -29,6 +29,8 @@ By that reason load test uses prepared load data which can be generated as follo
 
     ```bash
     sudo make localnet_clean
+
+    # DCL_OBSERVERS=1 make localnet_init  # to initialize observers as well
     make localnet_init
 
     # ./gentestaccounts.sh [<NUM-USERS>]

bench/prometheus.yml

@@ -31,7 +31,9 @@ scrape_configs:
     scrape_interval: 5s
 
     static_configs:
+      # TODO use different labels for nodes and observers
       - targets: ['localhost:26650']
       - targets: ['localhost:26651']
       - targets: ['localhost:26652']
       - targets: ['localhost:26653']
+      - targets: ['localhost:26654']

docker-compose.yml

@@ -75,6 +75,27 @@ services:
     # Please use the following as the entry point if you want to start this node in debug mode for easy debugging
     # command: dlv --listen=:2345 --headless=true --log=true --log-output=debugger,debuglineerr,gdbwire,lldbout,rpc --accept-multiclient --api-version=2 exec /usr/bin/dcld start
 
+  observer0:
+    image: dcledger
+    build: .
+    profiles:
+      - observers
+    container_name: observer0
+    ports:
+      - "26664-26665:26656-26657"
+      - "26654:26660"
+      # uncomment following line if starting in debug mode
+      # - "2345:2345"
+    volumes:
+      - ./localnet/observer0:/root/.dcld:Z
+    networks:
+      localnet:
+        ipv4_address: 192.167.10.6
+    command: dcld start
+    # Please use the following as the entry point if you want to start this node in debug mode for easy debugging
+    # command: dlv --listen=:2345 --headless=true --log=true --log-output=debugger,debuglineerr,gdbwire,lldbout,rpc --accept-multiclient --api-version=2 exec /usr/bin/dcld start
+
+
 networks:
   localnet:
     driver: bridge

docs/design/benchmarking.md

@@ -19,7 +19,7 @@
 *   `response time` (percentiles): the time between client's initial request and the last byte of a validator response
 *   `requests per second (RPS)`: number of requests per second
 *   `transactions per second (TPS)`: number of write requests (txns) per second
-    *   **Note** to measure that on client side write requests should use to `broadcast_tx_commit` requetss
+    *   **Note** to measure that on a client side write requests should use `broadcast_tx_commit` requests
 *   `number of clients`: number of concurrent clients that ledger serves
 *   (optional) `throughtput` (in/out): number of KB per second. Marked as optional since we don't expect much in/out data due to relatively small txns payloads.
 

genlocalnetconfig.sh

@@ -15,6 +15,8 @@
 
 set -euo pipefail
 
+DCL_OBSERVERS="${DCL_OBSERVERS:-}"
+
 SED_EXT=
 if [ "$(uname)" == "Darwin" ]; then
     # Mac OS X sed needs the file extension when -i flag is used. Keeping it empty as we don't need backupfile
@@ -27,6 +29,10 @@ rm -rf ~/.dcld
 rm -rf localnet
 mkdir localnet localnet/client localnet/node0 localnet/node1 localnet/node2 localnet/node3
 
+if [[ -n "$DCL_OBSERVERS" ]]; then
+    mkdir localnet/observer0
+fi
+
 # client
 
 dclcli config chain-id dclchain
@@ -105,8 +111,24 @@ echo 'test1234' | dcld gentx --from anna
 
 cp -r ~/.dcld/* localnet/node3
 
+
+if [[ -d "localnet/observer0" ]]; then
+    rm -rf ~/.dcld/*
+    # observer0
+
+    dcld init observer0 --chain-id dclchain
+
+    dcld add-genesis-account --address=$jack_address --pubkey=$jack_pubkey --roles="Trustee,NodeAdmin"
+    dcld add-genesis-account --address=$alice_address --pubkey=$alice_pubkey --roles="Trustee,NodeAdmin"
+    dcld add-genesis-account --address=$bob_address --pubkey=$bob_pubkey --roles="Trustee,NodeAdmin"
+    dcld add-genesis-account --address=$anna_address --pubkey=$anna_pubkey --roles="NodeAdmin"
+
+    cp -r ~/.dcld/* localnet/observer0
+fi
+
 # Collect all validator creation transactions
 
+mkdir -p ~/.dcld/config/gentx
 cp localnet/node0/config/gentx/* ~/.dcld/config/gentx
 cp localnet/node1/config/gentx/* ~/.dcld/config/gentx
 cp localnet/node2/config/gentx/* ~/.dcld/config/gentx
@@ -124,6 +146,10 @@ cp ~/.dcld/config/genesis.json localnet/node1/config/
 cp ~/.dcld/config/genesis.json localnet/node2/config/
 cp ~/.dcld/config/genesis.json localnet/node3/config/
 
+if [[ -d "localnet/observer0" ]]; then
+    cp ~/.dcld/config/genesis.json localnet/observer0/config/
+fi
+
 # Find out node ids
 
 id0=$(ls localnet/node0/config/gentx | sed 's/gentx-\(.*\).json/\1/')
@@ -136,10 +162,14 @@ peers="$id0@192.167.10.2:26656,$id1@192.167.10.3:26656,$id2@192.167.10.4:26656,$
 
 # Update address book of the first node 
 sed -i $SED_EXT "s/persistent_peers = \"\"/persistent_peers = \"$peers\"/g" localnet/node0/config/config.toml
+if [[ -d "localnet/observer0" ]]; then
+    sed -i $SED_EXT "s/persistent_peers = \"\"/persistent_peers = \"$peers\"/g" localnet/observer0/config/config.toml
+fi
 
 # Make RPC endpoint available externally
-sed -i $SED_EXT "s/persistent_peers = \"\"/persistent_peers = \"$peers\"/g" localnet/node0/config/config.toml
-for idx in 0 1 2 3; do
-    sed -i $SED_EXT 's/laddr = "tcp:\/\/127.0.0.1:26657"/laddr = "tcp:\/\/0.0.0.0:26657"/g' "localnet/node${idx}/config/config.toml"
-    sed -i $SED_EXT 's/prometheus = false/prometheus = true/g' "localnet/node${idx}/config/config.toml"
+for node_id in node0 node1 node2 node3 observer0; do
+    if [[ -d "localnet/${node_id}" ]]; then
+        sed -i $SED_EXT 's/laddr = "tcp:\/\/127.0.0.1:26657"/laddr = "tcp:\/\/0.0.0.0:26657"/g' "localnet/${node_id}/config/config.toml"
+        sed -i $SED_EXT 's/prometheus = false/prometheus = true/g' "localnet/${node_id}/config/config.toml"
+    fi
 done

gentestaccounts.sh

@@ -41,7 +41,8 @@ done
 dcld validate-genesis
 
 cp -r ~/.dclcli/* localnet/client
-cp -f ~/.dcld/config/genesis.json localnet/node0/config/
-cp -f ~/.dcld/config/genesis.json localnet/node1/config/
-cp -f ~/.dcld/config/genesis.json localnet/node2/config/
-cp -f ~/.dcld/config/genesis.json localnet/node3/config/
+for node_id in node0 node1 node2 node3 observer0; do
+    if [[ -d "localnet/${node_id}" ]]; then
+        cp -f ~/.dcld/config/genesis.json "localnet/${node_id}/config/"
+    fi
+done