[FAB-5345] Update sample Kafka.Brokers value

Based on user feedback we need to make it clearer that this value needs to be edited. We should also show in practice how a list is populated with the YAML syntax. This changeset addresses this. Change-Id: Iff0f887450dbe23983eb6b3517a42235228813e0 Signed-off-by: Kostas Christidis <kostas@christidis.io>
hyperledger · Jul 17, 2017 · e193926 · e193926
1 parent f67b9c9
commit e193926
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 11 deletions.
diff --git a/examples/cluster/config/configtx.yaml b/examples/cluster/config/configtx.yaml
@@ -111,10 +111,13 @@ Orderer: &OrdererDefaults
         PreferredMaxBytes: 512 KB
 
     Kafka:
-        # Brokers: A list of Kafka brokers to which the orderer connects
-        # NOTE: Use IP:port notation
+        # Brokers: A list of Kafka brokers to which the orderer connects. Edit
+        # this list to identify the brokers of the ordering service.
+        # NOTE: Use IP:port notation.
         Brokers:
-            - 127.0.0.1:9092
+            - kafka0:9092
+            - kafka1:9092
+            - kafka2:9092
 
     # Organizations is the list of orgs which are defined as participants on
     # the orderer side of the network

diff --git a/examples/e2e_cli/configtx.yaml b/examples/e2e_cli/configtx.yaml
@@ -125,10 +125,13 @@ Orderer: &OrdererDefaults
         PreferredMaxBytes: 512 KB
 
     Kafka:
-        # Brokers: A list of Kafka brokers to which the orderer connects
-        # NOTE: Use IP:port notation
+        # Brokers: A list of Kafka brokers to which the orderer connects. Edit
+        # this list to identify the brokers of the ordering service.
+        # NOTE: Use IP:port notation.
         Brokers:
-            - 127.0.0.1:9092
+            - kafka0:9092
+            - kafka1:9092
+            - kafka2:9092
 
     # Organizations is the list of orgs which are defined as participants on
     # the orderer side of the network

diff --git a/sampleconfig/configtx.yaml b/sampleconfig/configtx.yaml
@@ -167,10 +167,13 @@ Orderer: &OrdererDefaults
     MaxChannels: 0
 
     Kafka:
-        # Brokers: A list of Kafka brokers to which the orderer connects.
-        # NOTE: Use IP:port notation
+        # Brokers: A list of Kafka brokers to which the orderer connects. Edit
+        # this list to identify the brokers of the ordering service.
+        # NOTE: Use IP:port notation.
         Brokers:
-            - 127.0.0.1:9092
+            - kafka0:9092
+            - kafka1:9092
+            - kafka2:9092
 
     # Organizations is the list of orgs which are defined as participants on
     # the orderer side of the network.

diff --git a/test/feature/configs/configtx.yaml b/test/feature/configs/configtx.yaml
@@ -196,8 +196,9 @@ Orderer: &OrdererDefaults
     MaxChannels: 0
 
     Kafka:
-        # Brokers: A list of Kafka brokers to which the orderer connects.
-        # NOTE: Use IP:port notation
+        # Brokers: A list of Kafka brokers to which the orderer connects. Edit
+        # this list to identify the brokers of the ordering service.
+        # NOTE: Use IP:port notation.
         Brokers:
             - kafka0:9092
             - kafka1:9092