Hyperledger Fabric 1.0 从零开始（十三）——orderer分布式方案

./bin/cryptogen generate --config=./crypto-config.yaml

 1 ################################################################################
 2 #
 3 #   SECTION: Orderer
 4 #
 5 #   - This section defines the values to encode into a config transaction or
 6 #   genesis block for orderer related parameters
 7 #
 8 ################################################################################
 9 Orderer: &OrdererExample
10 
11     # Orderer Type: The orderer implementation to start
12     # Available types are "solo" and "kafka"
13     OrdererType: kafka
14 
15     Addresses:
16         - orderer0.example.com:7050
17         - orderer1.example.com:7050
18         - orderer2.example.com:7050
19 
20     # Batch Timeout: The amount of time to wait before creating a batch
21     BatchTimeout: 2s
22 
23     # Batch Size: Controls the number of messages batched into a block
24     BatchSize:
25 
26         # Max Message Count: The maximum number of messages to permit in a batch
27         MaxMessageCount: 10
28 
29         # Absolute Max Bytes: The absolute maximum number of bytes allowed for
30         # the serialized messages in a batch.
31         # 设置最大的区块大小。每个区块最大有Orderer.AbsoluteMaxBytes个字节（不包括头部）。
32         # 假定这里设置的值为A，记住这个值，这会影响怎样配置Kafka代理。
33         AbsoluteMaxBytes: 99 MB
34 
35         # Preferred Max Bytes: The preferred maximum number of bytes allowed for
36         # the serialized messages in a batch. A message larger than the preferred
37         # max bytes will result in a batch larger than preferred max bytes.
38         # 设置每个区块建议的大小。Kafka对于相对小的消息提供更高的吞吐量；区块大小最好不要超过1MB。
39         PreferredMaxBytes: 512 KB
40 
41     Kafka:
42         # Brokers: A list of Kafka brokers to which the orderer connects
43         # NOTE: Use IP:port notation
44         # 包含Kafka集群中至少两个代理的地址信息（IP：port），
45         # 这个list不需要是完全的（这些是你的种子代理），
46         # 这个代理表示当前Order所要连接的Kafka代理。
47         Brokers:
48             - x.x.x.x:9092
49             - x.x.x.xx:9092
50 
51     # Organizations is the list of orgs which are defined as participants on
52     # the orderer side of the network
53     Organizations:

 1 # Copyright IBM Corp. All Rights Reserved.
 2 #
 3 # SPDX-License-Identifier: Apache-2.0
 4 # 
 5 # ZooKeeper的基本运转流程：
 6 # 1、选举Leader。
 7 # 2、同步数据。
 8 # 3、选举Leader过程中算法有很多，但要达到的选举标准是一致的。
 9 # 4、Leader要具有最高的执行ID，类似root权限。
10 # 5、集群中大多数的机器得到响应并follow选出的Leader。
11 #
12 
13 version: '2'
14 
15 services:
16 
17   zookeeper1:
18     container_name: zookeeper1
19     hostname: zookeeper1
20     image: hyperledger/fabric-zookeeper
21     restart: always
22     environment:
23       # ========================================================================
24       #     Reference: https://zookeeper.apache.org/doc/r3.4.9/zookeeperAdmin.html#sc_configuration
25       # ========================================================================
26       #
27       # myid
28       # The ID must be unique within the ensemble and should have a value
29       # ID在集合中必须是唯一的并且应该有一个值
30       # between 1 and 255.
31       # 在1和255之间。
32       - ZOO_MY_ID=1
33       #
34       # server.x=[hostname]:nnnnn[:nnnnn]
35       # The list of servers that make up the ZK ensemble. The list that is used
36       # by the clients must match the list of ZooKeeper servers that each ZK
37       # server has. There are two port numbers `nnnnn`. The first is what
38       # followers use to connect to the leader, while the second is for leader
39       # election.
40       # 组成ZK集合的服务器列表。客户端使用的列表必须与ZooKeeper服务器列表所拥有的每一个ZK服务器相匹配。
41       # 有两个端口号 `nnnnn`。第一个是追随者用来连接领导者的东西，第二个是领导人选举。
42       - ZOO_SERVERS=server.1=zookeeper1:2888:3888 server.2=zookeeper2:2888:3888 server.3=zookeeper3:2888:3888
43     ports:
44       - "2181:2181"
45       - "2888:2888"
46       - "3888:3888"
47     extra_hosts:
48      - "zookeeper1:x.x.x.x"
49      - "zookeeper2:x.x.x.xx"
50      - "zookeeper3:x.x.x.xxx"
51      - "kafka1:xx.x.x.x"
52      - "kafka2:xx.x.x.xx"
53      - "kafka3:xx.x.x.xxx"
54      - "kafka3:xx.x.x.xxxx"

  1 # Copyright IBM Corp. All Rights Reserved.
  2 #
  3 # SPDX-License-Identifier: Apache-2.0
  4 #
  5 
  6 version: '2'
  7 
  8 services:
  9 
 10   kafka1:
 11     container_name: kafka1
 12     hostname: kafka1
 13     image: hyperledger/fabric-kafka
 14     restart: always
 15     environment:
 16       # ========================================================================
 17       #     Reference: https://kafka.apache.org/documentation/#configuration
 18       # ========================================================================
 19       #
 20       # broker.id
 21       - KAFKA_BROKER_ID=1
 22       #
 23       # min.insync.replicas
 24       # Let the value of this setting be M. Data is considered committed when
 25       # it is written to at least M replicas (which are then considered in-sync
 26       # and belong to the in-sync replica set, or ISR). In any other case, the
 27       # write operation returns an error. Then:
 28       # 1. If up to M-N replicas -- out of the N (see default.replication.factor
 29       # below) that the channel data is written to -- become unavailable,
 30       # operations proceed normally.
 31       # 2. If more replicas become unavailable, Kafka cannot maintain an ISR set
 32       # of M, so it stops accepting writes. Reads work without issues. The
 33       # channel becomes writeable again when M replicas get in-sync.
 34       # 
 35       # min.insync.replicas = M---设置一个M值（例如1<M<N，查看下面的default.replication.factor）
 36       # 数据提交时会写入至少M个副本（这些数据然后会被同步并且归属到in-sync 副本集合或ISR）。
 37       # 其它情况，写入操作会返回一个错误。接下来：
 38       # 1）如果channel写入的数据多达N-M个副本变的不可用，操作可以正常执行。
 39       # 2）如果有更多的副本不可用，Kafka不可以维护一个有M数量的ISR集合，因此Kafka停止接收写操作。Channel只有当同步M个副本后才可以重新可以写。
 40       - KAFKA_MIN_INSYNC_REPLICAS=2
 41       #
 42       # default.replication.factor
 43       # Let the value of this setting be N. A replication factor of N means that
 44       # each channel will have its data replicated to N brokers. These are the
 45       # candidates for the ISR set of a channel. As we noted in the
 46       # min.insync.replicas section above, not all of these brokers have to be
 47       # available all the time. In this sample configuration we choose a
 48       # default.replication.factor of K-1 (where K is the total number of brokers in
 49       # our Kafka cluster) so as to have the largest possible candidate set for
 50       # a channel's ISR. We explicitly avoid setting N equal to K because
 51       # channel creations cannot go forward if less than N brokers are up. If N
 52       # were set equal to K, a single broker going down would mean that we would
 53       # not be able to create new channels, i.e. the crash fault tolerance of
 54       # the ordering service would be non-existent.
 55       # 
 56       # 设置一个值N，N<K。
 57       # 设置replication factor参数为N代表着每个channel都保存N个副本的数据到Kafka的代理上。
 58       # 这些都是一个channel的ISR集合的候选。
 59       # 如同在上边min.insync.replicas section设置部分所描述的，不是所有的代理（orderer）在任何时候都是可用的。
 60       # N的值必须小于K，如果少于N个代理的话，channel的创建是不能成功的。
 61       # 因此，如果设置N的值为K，一个代理失效后，那么区块链网络将不能再创建新的channel---orderering service的crash容错也就不存在了。
 62       - KAFKA_DEFAULT_REPLICATION_FACTOR=3
 63       #
 64       # zookeper.connect
 65       # Point to the set of Zookeeper nodes comprising a ZK ensemble.
 66       # 指向Zookeeper节点的集合，其中包含ZK的集合。
 67       - KAFKA_ZOOKEEPER_CONNECT=zookeeper1:2181,zookeeper2:2181,zookeeper3:2181
 68       #
 69       # zookeeper.connection.timeout.ms
 70       # The max time that the client waits to establish a connection to
 71       # Zookeeper. If not set, the value in zookeeper.session.timeout.ms (below)
 72       # is used.
 73       #- KAFKA_ZOOKEEPER_CONNECTION_TIMEOUT_MS = 6000
 74       #
 75       # zookeeper.session.timeout.ms
 76       #- KAFKA_ZOOKEEPER_SESSION_TIMEOUT_MS = 6000
 77       #
 78       # socket.request.max.bytes
 79       # The maximum number of bytes in a socket request. ATTN: If you set this
 80       # env var, make sure to update `brokerConfig.Producer.MaxMessageBytes` in
 81       # `newBrokerConfig()` in `fabric/orderer/kafka/config.go` accordingly.
 82       #- KAFKA_SOCKET_REQUEST_MAX_BYTES=104857600 # 100 * 1024 * 1024 B
 83       #
 84       # message.max.bytes
 85       # The maximum size of envelope that the broker can receive.
 86       # 
 87       # 在configtx.yaml中会设置最大的区块大小（参考configtx.yaml中AbsoluteMaxBytes参数）。
 88       # 每个区块最大有Orderer.AbsoluteMaxBytes个字节（不包括头部），假定这里设置的值为A（目前99）。
 89       # message.max.bytes和replica.fetch.max.bytes应该设置一个大于A。
 90       # 为header增加一些缓冲区空间---1MB已经足够大。上述不同设置值之间满足如下关系：
 91       # Orderer.AbsoluteMaxBytes < replica.fetch.max.bytes <= message.max.bytes
 92       # （更完整的是，message.max.bytes应该严格小于socket.request.max.bytes的值，socket.request.max.bytes的值默认被设置为100MB。
 93       # 如果想要区块的大小大于100MB，需要编辑fabric/orderer/kafka/config.go文件里硬编码的值brokerConfig.Producer.MaxMessageBytes，
 94       # 修改后重新编译源码得到二进制文件，这种设置是不建议的。）
 95       - KAFKA_MESSAGE_MAX_BYTES=103809024 # 99 * 1024 * 1024 B
 96       #
 97       # replica.fetch.max.bytes
 98       # The number of bytes of messages to attempt to fetch for each channel.
 99       # This is not an absolute maximum, if the fetched envelope is larger than
100       # this value, the envelope will still be returned to ensure that progress
101       # can be made. The maximum message size accepted by the broker is defined
102       # via message.max.bytes above.
103       # 
104       # 试图为每个通道获取的消息的字节数。
105       # 这不是绝对最大值，如果获取的信息大于这个值，则仍然会返回信息，以确保可以取得进展。
106       # 代理所接受的最大消息大小是通过上一条message.max.bytes定义的。
107       - KAFKA_REPLICA_FETCH_MAX_BYTES=103809024 # 99 * 1024 * 1024 B
108       #
109       # unclean.leader.election.enable
110       # Data consistency is key in a blockchain environment. We cannot have a
111       # leader chosen outside of the in-sync replica set, or we run the risk of
112       # overwriting the offsets that the previous leader produced, and --as a
113       # result-- rewriting the blockchain that the orderers produce.
114       # 数据一致性在区块链环境中是至关重要的。
115       # 我们不能从in-sync 副本（ISR）集合之外选取channel leader，
116       # 否则我们将会面临对于之前的leader产生的offsets覆盖的风险，
117       # 这样的结果是，orderers产生的区块可能会重新写入区块链。
118       - KAFKA_UNCLEAN_LEADER_ELECTION_ENABLE=false
119       #
120       # log.retention.ms
121       # Until the ordering service in Fabric adds support for pruning of the
122       # Kafka logs, time-based retention should be disabled so as to prevent
123       # segments from expiring. (Size-based retention -- see
124       # log.retention.bytes -- is disabled by default so there is no need to set
125       # it explicitly.)
126       # 
127       # 除非orderering service对Kafka日志的修剪增加支持，
128       # 否则需要关闭基于时间的日志保留方式并且避免分段到期
129       # （基于大小的日志保留方式log.retention.bytes在写本文章时在Kafka中已经默认关闭，因此不需要再次明确设置这个配置）。
130       - KAFKA_LOG_RETENTION_MS=-1
131     ports:
132       - "9092:9092"
133     extra_hosts:
134      - "zookeeper1:x.x.x.x"
135      - "zookeeper2:x.x.x.xx"
136      - "zookeeper3:x.x.x.xxx"
137      - "kafka1:xx.x.x.x"
138      - "kafka2:xx.x.x.xx"
139      - "kafka3:xx.x.x.xxx"
140      - "kafka4:xx.x.x.xxxx"

 1 # Copyright IBM Corp. All Rights Reserved.
 2 #
 3 # SPDX-License-Identifier: Apache-2.0
 4 #
 5 
 6 version: '2'
 7 
 8 services:
 9 
10   orderer0.example.com:
11     container_name: orderer0.example.com
12     image: hyperledger/fabric-orderer
13     environment:
14       - CORE_VM_DOCKER_HOSTCONFIG_NETWORKMODE=example_default
15       - ORDERER_GENERAL_LOGLEVEL=error
16       # - ORDERER_GENERAL_LOGLEVEL=debug
17       - ORDERER_GENERAL_LISTENADDRESS=0.0.0.0
18       - ORDERER_GENERAL_LISTENPORT=7050
19       #- ORDERER_GENERAL_GENESISPROFILE=ExampleOrdererGenesis
20       - ORDERER_GENERAL_GENESISMETHOD=file
21       - ORDERER_GENERAL_GENESISFILE=/var/hyperledger/orderer/orderer.genesis.block
22       - ORDERER_GENERAL_LOCALMSPID=ExampleMSP
23       - ORDERER_GENERAL_LOCALMSPDIR=/var/hyperledger/orderer/msp
24       #- ORDERER_GENERAL_LEDGERTYPE=ram
25       #- ORDERER_GENERAL_LEDGERTYPE=file
26       # enabled TLS
27       - ORDERER_GENERAL_TLS_ENABLED=false
28       - ORDERER_GENERAL_TLS_PRIVATEKEY=/var/hyperledger/orderer/tls/server.key
29       - ORDERER_GENERAL_TLS_CERTIFICATE=/var/hyperledger/orderer/tls/server.crt
30       - ORDERER_GENERAL_TLS_ROOTCAS=[/var/hyperledger/orderer/tls/ca.crt]
31 
32       - ORDERER_KAFKA_RETRY_LONGINTERVAL=10s 
33       - ORDERER_KAFKA_RETRY_LONGTOTAL=100s 
34       - ORDERER_KAFKA_RETRY_SHORTINTERVAL=1s
35       - ORDERER_KAFKA_RETRY_SHORTTOTAL=30s
36       - ORDERER_KAFKA_VERBOSE=true
37       - ORDERER_KAFKA_BROKERS=[xx.x.x.x:9092,xx.x.x.xx:9092,xx.x.x.xxx:9092,xx.x.x.xxxx:9092]
38     working_dir: /opt/gopath/src/github.com/hyperledger/fabric
39     command: orderer
40     volumes:
41     - ../config/channel-artifacts/genesis.block:/var/hyperledger/orderer/orderer.genesis.block
42     - ../config/crypto-config/ordererOrganizations/example.com/orderers/orderer0.example.com/msp:/var/hyperledger/orderer/msp
43     - ../config/crypto-config/ordererOrganizations/example.com/orderers/orderer0.example.com/tls/:/var/hyperledger/orderer/tls
44     networks:
45       default:
46         aliases:
47           - example
48     ports:
49       - 7050:7050
50     extra_hosts:
51      - "kafka1:xx.x.x.x"
52      - "kafka2:xx.x.x.xx"
53      - "kafka3:xx.x.x.xxx"
54      - "kafka4:xx.x.x.xxxx"