1相關文件說明
這一部分涉及相關配置文件的解析,
網絡的啟動涉及到多個文件,本文按以下順序進行分析:
.
├── base
│ ├── docker-compose-base.yaml #1
│ └── peer-base.yaml #2
├── channel-artifacts
├── configtx.yaml #5
├── crypto-config.yaml
├── docker-compose-cli.yaml #3
├── docker-compose-couch.yaml #4
├── docker-compose-e2e-template.yaml 該文件中定義了fabric-ca的配置信息。我們這里用不到,會在講解Fabric-Ca的文章中說明
3.1 docker-compose-base.yaml
文件詳解
先看一下文件內容:
version: '2' #docker版本
services: #服務,可以包括若干個容器實例
orderer.example.com: #定義一個名稱為orderer.example.com的服務
container_name: orderer.example.com #當前容器名稱
extends: #擴展,代表需要加載的文件或服務
file: peer-base.yaml
service: orderer-base
volumes: #掛載的卷 [本機路徑下的文件或目錄]:[容器中所映射到的地址]
#比如本機下的channel-artifacts/genesis.block文件可以在容器中/var/hyperledger/orderer/orderer.genesis.block訪問
- ../channel-artifacts/genesis.block:/var/hyperledger/orderer/orderer.genesis.block
- ../crypto-config/ordererOrganizations/example.com/orderers/orderer.example.com/msp:/var/hyperledger/orderer/msp
- ../crypto-config/ordererOrganizations/example.com/orderers/orderer.example.com/tls/:/var/hyperledger/orderer/tls
- orderer.example.com:/var/hyperledger/production/orderer
ports: #所映射的端口 [本機端口]:[容器端口]
- 7050:7050
peer0.org1.example.com: #定義一個名稱為peer0.org1.example.com的服務
container_name: peer0.org1.example.com #當前容器名稱
extends: #同上
file: peer-base.yaml
service: peer-base
environment: #定義環境變量
- CORE_PEER_ID=peer0.org1.example.com #peer節點的id
- CORE_PEER_ADDRESS=peer0.org1.example.com:7051 #peer節點的訪問地址
- CORE_PEER_LISTENADDRESS=0.0.0.0:7051 #peer節點的監聽地址
- CORE_PEER_CHAINCODEADDRESS=peer0.org1.example.com:7052 #peer節點的鏈碼訪問地址
- CORE_PEER_CHAINCODELISTENADDRESS=0.0.0.0:7052 #peer節點的鏈碼監聽地址 指定為0.0.0.0則自動進行探測
- CORE_PEER_GOSSIP_BOOTSTRAP=peer1.org1.example.com:8051 #gossip為共識機制
- CORE_PEER_GOSSIP_EXTERNALENDPOINT=peer0.org1.example.com:7051 #gossip外部節點,表明為錨節點
- CORE_PEER_LOCALMSPID=Org1MSP
volumes: #同上,掛載卷
- /var/run/:/host/var/run/
- ../crypto-config/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/msp:/etc/hyperledger/fabric/msp
- ../crypto-config/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls:/etc/hyperledger/fabric/tls
- peer0.org1.example.com:/var/hyperledger/production
ports: #同上,端口
- 7051:7051
peer1.org1.example.com:
container_name: peer1.org1.example.com
extends:
file: peer-base.yaml
service: peer-base
...
...
3.2 peer-base.yaml
文件詳解
version: '2'
services:
peer-base: #定義一個名稱為peer-base的服務
image: hyperledger/fabric-peer:$IMAGE_TAG #該服務所依賴的鏡像
environment: #定義環境變量
- CORE_VM_ENDPOINT=unix:///host/var/run/docker.sock
- CORE_VM_DOCKER_HOSTCONFIG_NETWORKMODE=${COMPOSE_PROJECT_NAME}_byfn #定義網絡工作模式,這里使用的是bridge方式
- FABRIC_LOGGING_SPEC=INFO #定義日志級別為INFO
#- FABRIC_LOGGING_SPEC=DEBUG
- CORE_PEER_TLS_ENABLED=true #使用TLS
- CORE_PEER_GOSSIP_USELEADERELECTION=true #使用選舉LEADER的方式
- CORE_PEER_GOSSIP_ORGLEADER=false #不指定LEADER
- CORE_PEER_PROFILE_ENABLED=true #使用profile
- CORE_PEER_TLS_CERT_FILE=/etc/hyperledger/fabric/tls/server.crt #TLS證書路徑
- CORE_PEER_TLS_KEY_FILE=/etc/hyperledger/fabric/tls/server.key #TLS密鑰路徑
- CORE_PEER_TLS_ROOTCERT_FILE=/etc/hyperledger/fabric/tls/ca.crt #TLS根證書路徑
working_dir: /opt/gopath/src/github.com/hyperledger/fabric/peer #工作目錄,即進入容器所在的默認位置
command: peer node start #啟動容器后所運行的第一條命令:啟動Peer節點
orderer-base: #定義一個名稱為orderer-base的服務
image: hyperledger/fabric-orderer:$IMAGE_TAG #該服務所依賴的鏡像
environment: #環境變量
- FABRIC_LOGGING_SPEC=INFO #日志級別
- ORDERER_GENERAL_LISTENADDRESS=0.0.0.0 #orderer的監聽地址
- ORDERER_GENERAL_GENESISMETHOD=file # 創世區塊文件的類型為file
- ORDERER_GENERAL_GENESISFILE=/var/hyperledger/orderer/orderer.genesis.block #創世區塊在容器中的路徑
- ORDERER_GENERAL_LOCALMSPID=OrdererMSP #Orderer的本地MSPid
- ORDERER_GENERAL_LOCALMSPDIR=/var/hyperledger/orderer/msp #本地Msp文件夾
# enabled TLS
- ORDERER_GENERAL_TLS_ENABLED=true #使用TLS
- ORDERER_GENERAL_TLS_PRIVATEKEY=/var/hyperledger/orderer/tls/server.key #TLS私鑰路徑
- ORDERER_GENERAL_TLS_CERTIFICATE=/var/hyperledger/orderer/tls/server.crt #TLS證書路徑
- ORDERER_GENERAL_TLS_ROOTCAS=[/var/hyperledger/orderer/tls/ca.crt] #TLS根證書路徑
- ORDERER_KAFKA_TOPIC_REPLICATIONFACTOR=1 #以下為kafka集群的配置,本文中沒有使用到
- ORDERER_KAFKA_VERBOSE=true
- ORDERER_GENERAL_CLUSTER_CLIENTCERTIFICATE=/var/hyperledger/orderer/tls/server.crt
- ORDERER_GENERAL_CLUSTER_CLIENTPRIVATEKEY=/var/hyperledger/orderer/tls/server.key
- ORDERER_GENERAL_CLUSTER_ROOTCAS=[/var/hyperledger/orderer/tls/ca.crt]
working_dir: /opt/gopath/src/github.com/hyperledger/fabric #工作目錄,即進入容器所在的默認位置
command: orderer #啟動容器后所運行的第一條命令:啟動orderer
3.3 docker-compose-cli.yaml
文件詳解
version: '2'
volumes: #聲明掛載的卷
orderer.example.com:
peer0.org1.example.com:
peer1.org1.example.com:
peer0.org2.example.com:
peer1.org2.example.com:
networks: #聲明一個名稱為byfn的網絡
byfn:
services:
orderer.example.com: #定義一個名稱為orderer.example.com的服務
extends: #擴展,代表需要加載的文件或服務 即使用了其中的配置信息
file: base/docker-compose-base.yaml
service: orderer.example.com
container_name: orderer.example.com #當前容器名稱
networks: #指定當前容器所加入的網絡,如果需要加入多個網絡,可以定義多個
- byfn
#以下同上
peer0.org1.example.com:
container_name: peer0.org1.example.com
extends:
file: base/docker-compose-base.yaml
service: peer0.org1.example.com
networks:
- byfn
peer1.org1.example.com:
container_name: peer1.org1.example.com
extends:
file: base/docker-compose-base.yaml
service: peer1.org1.example.com
networks:
- byfn
peer0.org2.example.com:
container_name: peer0.org2.example.com
extends:
file: base/docker-compose-base.yaml
service: peer0.org2.example.com
networks:
- byfn
peer1.org2.example.com:
container_name: peer1.org2.example.com
extends:
file: base/docker-compose-base.yaml
service: peer1.org2.example.com
networks:
- byfn
cli: #定義一個客戶端容器,方便與各節點進行交互
container_name: cli #客戶端容器名稱
image: hyperledger/fabric-tools:$IMAGE_TAG #該服務所依賴的鏡像
tty: true #使用偽終端
stdin_open: true #標准輸入
environment: #環境變量
- GOPATH=/opt/gopath #指定go的路徑
- CORE_VM_ENDPOINT=unix:///host/var/run/docker.sock
#- FABRIC_LOGGING_SPEC=DEBUG
- FABRIC_LOGGING_SPEC=INFO #日志級別
- CORE_PEER_ID=cli #當前節點的Id
- CORE_PEER_ADDRESS=peer0.org1.example.com:7051 #以下與peer-base.yaml相同,表示當前客戶端容器默認與peer0.org1.example.com進行交互
- CORE_PEER_LOCALMSPID=Org1MSP
- CORE_PEER_TLS_ENABLED=true
- CORE_PEER_TLS_CERT_FILE=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/server.crt #TLS-peer0.org1.example.com的證書路徑
- CORE_PEER_TLS_KEY_FILE=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/server.key #TLS-peer0.org1.example.com的密鑰路徑
- CORE_PEER_TLS_ROOTCERT_FILE=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt #TLS-peer0.org1.example.com的根證書路徑
- CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp @#TLS-組織1中Admin的MSP路徑
working_dir: /opt/gopath/src/github.com/hyperledger/fabric/peer #工作目錄,即進入容器所在的默認位置
command: /bin/bash #啟動容器后所運行的第一條命令:使用bash
volumes: #掛載卷
- /var/run/:/host/var/run/
- ./../chaincode/:/opt/gopath/src/github.com/chaincode
- ./crypto-config:/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/
- ./scripts:/opt/gopath/src/github.com/hyperledger/fabric/peer/scripts/
- ./channel-artifacts:/opt/gopath/src/github.com/hyperledger/fabric/peer/channel-artifacts
depends_on: #依賴,需要首先按順序啟動以下容器,但是不會等待以下容器完全啟動才啟動當前容器
- orderer.example.com
- peer0.org1.example.com
- peer1.org1.example.com
- peer0.org2.example.com
- peer1.org2.example.com
networks: #指定當前容器所加入的網絡
- byfn
3.4 docker-compose-couch.yaml
文件詳解
在fabric網絡中,可以使用默認的levelDb數據庫,或者使用CouchDb,該文件主要是對CouchDb進行相關設置。
version: '2'
networks: #聲明一個名稱為byfn的網絡
byfn:
services:
couchdb0: #定義一個couchdb0的服務
container_name: couchdb0 #指定該容器名稱為couchdb0
image: hyperledger/fabric-couchdb #該容器所依賴的鏡像
environment: #環境變量
- COUCHDB_USER= #couchdb0的用戶名,這里設置為空,表明任何人都可登陸
- COUCHDB_PASSWORD= #couchdb0的登陸密碼,這里設置為空
ports: #所映射的端口
- "5984:5984"
networks: #使用的網絡
- byfn
peer0.org1.example.com: #定義一個peer0.org1.example.com的服務
environment:
- CORE_LEDGER_STATE_STATEDATABASE=CouchDB #指定該服務使用的標准數據庫為CouchDB
- CORE_LEDGER_STATE_COUCHDBCONFIG_COUCHDBADDRESS=couchdb0:5984 #指定該服務使用的數據庫訪問地址
- CORE_LEDGER_STATE_COUCHDBCONFIG_USERNAME= #配置數據庫用戶名
- CORE_LEDGER_STATE_COUCHDBCONFIG_PASSWORD=#配置數據庫密碼
depends_on: #表明該服務依賴於couchdb0
- couchdb0
couchdb1: #以下同上
container_name: couchdb1
image: hyperledger/fabric-couchdb
...
...
3.5 configtx.yaml
文件詳解
該文件中定義了fabric網絡中的相關策略信息,內容相對比較多,這里只講解所用到的部分。
Organizations: #組織信息
- &OrdererOrg #配置orderer的信息
Name: OrdererOrg #定義名稱
ID: OrdererMSP #定義ID
MSPDir: crypto-config/ordererOrganizations/example.com/msp #指定MSP的文件目錄
Policies: #定義相關策略
Readers: #可讀
Type: Signature
Rule: "OR('OrdererMSP.member')" #具體策略:允許OrdererMSP中所有member讀操作
Writers: #可寫
Type: Signature
Rule: "OR('OrdererMSP.member')"
Admins: #admin
Type: Signature
Rule: "OR('OrdererMSP.admin')"
- &Org1 #配置組織一的信息
Name: Org1MSP #定義組織一的名稱
ID: Org1MSP #定義組織一的ID
MSPDir: crypto-config/peerOrganizations/org1.example.com/msp #指定MSP的文件目錄
Policies: #定義相關策略
Readers: #可讀
Type: Signature
Rule: "OR('Org1MSP.admin', 'Org1MSP.peer', 'Org1MSP.client')" #Org1MSP中的admin,peer,client均可進行讀操作
Writers: #可寫
Type: Signature
Rule: "OR('Org1MSP.admin', 'Org1MSP.client')" #Org1MSP中的admin,client均可進行讀操作
Admins: #同上
Type: Signature
Rule: "OR('Org1MSP.admin')"
AnchorPeers: #指定Org1的錨節點,只有錨節點可以與另一個組織進行通信
- Host: peer0.org1.example.com #指定Org1的錨節點的地址
Port: 7051 #指定Org1的錨節點的端口
- &Org2 #同上
Name: Org2MSP
ID: Org2MSP
MSPDir: crypto-config/peerOrganizations/org2.example.com/msp
Policies:
Readers:
Type: Signature
Rule: "OR('Org2MSP.admin', 'Org2MSP.peer', 'Org2MSP.client')"
Writers:
Type: Signature
Rule: "OR('Org2MSP.admin', 'Org2MSP.client')"
Admins:
Type: Signature
Rule: "OR('Org2MSP.admin')"
AnchorPeers:
- Host: peer0.org2.example.com
Port: 9051
Capabilities: #這一區域主要是定義版本的兼容情況
Channel: &ChannelCapabilities
V1_3: true
Orderer: &OrdererCapabilities
V1_1: true
Application: &ApplicationCapabilities
V1_3: true
V1_2: false
V1_1: false
Application: &ApplicationDefaults #同上,定義具體的策略
Organizations:
Policies:
Readers:
Type: ImplicitMeta
Rule: "ANY Readers"
Writers:
Type: ImplicitMeta
Rule: "ANY Writers"
Admins:
Type: ImplicitMeta
Rule: "MAJORITY Admins"
Capabilities:
<<: *ApplicationCapabilities
################################################################################
#
Orderer: &OrdererDefaults
OrdererType: solo #定義網絡類型為solo
Addresses: #定義orderer的地址
- orderer.example.com:7050
BatchTimeout: 2s #定義創建一個區塊的超時時間
BatchSize:
MaxMessageCount: 10 #區塊內最大消息數
AbsoluteMaxBytes: 99 MB #區塊內消息所占的最大空間
PreferredMaxBytes: 512 KB
Organizations:
Policies:
Readers:
Type: ImplicitMeta
Rule: "ANY Readers"
Writers:
Type: ImplicitMeta
Rule: "ANY Writers"
Admins:
Type: ImplicitMeta
Rule: "MAJORITY Admins"
BlockValidation: #區塊的驗證策略
Type: ImplicitMeta
Rule: "ANY Writers"
################################################################################
Channel: &ChannelDefaults
Policies:
Readers: #定義誰可以調用交付區塊的API
Type: ImplicitMeta
Rule: "ANY Readers"
Writers: #定義誰可以調用廣播區塊的API
Type: ImplicitMeta
Rule: "ANY Writers"
Admins: #定義誰可以修改配置信息
Type: ImplicitMeta
Rule: "MAJORITY Admins"
Capabilities:
<<: *ChannelCapabilities
Profiles:
TwoOrgsOrdererGenesis:
<<: *ChannelDefaults
Orderer:
<<: *OrdererDefaults
Organizations:
- *OrdererOrg
Capabilities:
<<: *OrdererCapabilities
Consortiums:
SampleConsortium:
Organizations:
- *Org1
- *Org2
TwoOrgsChannel:
Consortium: SampleConsortium
<<: *ChannelDefaults
Application:
<<: *ApplicationDefaults
Organizations:
- *Org1
- *Org2
Capabilities:
<<: *ApplicationCapabilities