序言:
docker-compose是什么在這里不多說,可以去網上看看,及一些入門的東西
本文主要是從fabric配置文件的角度說說docker-compose 的用法
一,Yaml模板文件&docker 指令
模板文件是使用 Compose 的核心,默認的模板文件名稱為 docker-compose.yml
,格式為 YAML 格式。
在舊版本(版本 1)中,其中每個頂級元素為服務名稱,次級元素為服務容器的配置信息,例如
1 webapp: 2 image: examples/web 3 ports: 4 - "80:80" 5 volumes: 6 - "/data"
版本 2 擴展了 Compose 的語法,同時盡量保持跟版本 1 的兼容,除了可以聲明網絡和存儲信息外,最大的不同一是添加了版本信息,另一個是需要將所有的服務放到 services
根下面。例如,上面例子改寫為版本 2,內容為
1 version: "2" 2 services: 3 webapp: 4 image: examples/web 5 ports: 6 - "80:80" 7 volumes: 8 - "/data"
在Fabric網絡,涉及的docker-composer文件,都是版本2的compose語法。
注意!每個服務都必須通過 image
指令指定鏡像或 build
指令(需要 Dockerfile)等來自動構建生成鏡像。
yml文件中的docker 指令介紹
1> container_name
指定容器名稱。默認將會使用 項目名稱_服務名稱_序號 這樣的格式。
[例如] container_name: docker-web-container
2>image
指定為鏡像名稱或鏡像 ID。如果鏡像在本地不存在,Compose 將會嘗試拉去這個鏡像。
[例如]
image: ubuntu
image: orchardup/postgresql
image: a4bc65fd
3>command
覆蓋容器啟動后默認執行的命令。
[例如] command: echo "hello world"
4>environment
設置環境變量。你可以使用數組或字典兩種格式。
只給定名稱的變量會自動獲取運行 Compose 主機上對應變量的值,可以用來防止泄露不必要的數據。
[例如]
environment:
RACK_ENV: development
SESSION_SECRET:
[或者]
environment:
- RACK_ENV=development
- SESSION_SECRET
5>extends
基於其它模板文件進行擴展。
例如我們已經有了一個 webapp 服務,定義一個基礎模板文件為 common.yml。
# common.yml
webapp:
build: ./webapp
environment:
- DEBUG=false
- SEND_EMAILS=false
再編寫一個新的 development.yml 文件,使用 common.yml 中的 webapp 服務進行擴展。
# development.yml
web:
extends:
file: common.yml
service: webapp
ports:
- "8000:8000"
links:
- db
environment:
- DEBUG=true
db:
image: postgres
后者會自動繼承 common.yml 中的 webapp 服務及環境變量定義。設計是不是很巧妙
6>working_dir
指定容器中工作目錄。
[例如]:working_dir: /code
7>volumes
數據卷所掛載路徑設置。可以設置宿主機路徑 (HOST:CONTAINER) 或加上訪問模式 (HOST:CONTAINER:ro)。該指令中路徑支持相對路徑。
[例如]
volumes:
- /var/lib/mysql
- cache/:/tmp/cache
- ~/configs:/etc/configs/:ro
8>ports
暴露端口信息。
使用宿主:容器 (HOST:CONTAINER)格式 或者 僅僅指定容器的端口(宿主將會隨機選擇端口)都可以。
[例如]
ports:
- "3000" - "8000:8000" - "49100:22" - "127.0.0.1:8001:8001"
在fabric網絡搭建的過程中,關於peer節點的docker-compose文件配置內容如下:
peer0.org1.example.com:
container_name: peer0.org1.example.com
...
ports:
- 7051:7051
- 7053:7053
peer1.org1.example.com:
container_name: peer1.org1.example.com
...
ports:
- 8051:7051
- 8053:7053
peer0.org2.example.com:
container_name: peer0.org2.example.com
...
ports:
- 9051:7051
- 9053:7053
peer1.org2.example.com:
container_name: peer1.org2.example.com
...
ports:
- 10051:7051
- 10053:7053
在上述的配置中,通過將宿主主機的本地端口7051、8051、9051、10051等四個端口,分別映射為四個docker容器的7051端口;將7052、8052、90052、10052等四個端口,分別映射為docker容器的7052端口。
9>tty
模擬一個假的遠程控制台。
[例如] tty:true
10>build
指定 Dockerfile 所在文件夾的路徑(可以是絕對路徑,或者相對 docker-compose.yml 文件的路徑)。 Compose 將會利用它自動構建這個鏡像,然后使用這個鏡像。
[例如]:build: /path/to/build/dir
11>depends_on
可以保證build的先后順序。
[例如]:
depends_on:
- orderer.example.com
- peer0.org1.example.com
二,Orderer節點配置文件 | docker-compose-base.yaml
Orderer的配置是在base/docker-compose-base.yaml里面。
結合上面一部分的docker命令,我們對該文件進行注釋
# Copyright IBM Corp. All Rights Reserved.
#
# SPDX-License-Identifier: Apache-2.0
#
version: '2' # 表示用的是版本2的YAML模板
services: # 在版本2中,所有的服務都要放在services根下面
orderer.example.com: # Orderer排序服務
container_name: orderer.example.com # 定義容器的名稱
image: hyperledger/fabric-orderer # 指定容器的鏡像
environment: # 設置環境變量
- ORDERER_GENERAL_LOGLEVEL=debug
- ORDERER_GENERAL_LISTENADDRESS=0.0.0.0
- ORDERER_GENERAL_GENESISMETHOD=file
- ORDERER_GENERAL_GENESISFILE=/var/hyperledger/orderer/orderer.genesis.block
- ORDERER_GENERAL_LOCALMSPID=OrdererMSP
- ORDERER_GENERAL_LOCALMSPDIR=/var/hyperledger/orderer/msp
# enabled TLS
- ORDERER_GENERAL_TLS_ENABLED=true
- ORDERER_GENERAL_TLS_PRIVATEKEY=/var/hyperledger/orderer/tls/server.key
- ORDERER_GENERAL_TLS_CERTIFICATE=/var/hyperledger/orderer/tls/server.crt
- ORDERER_GENERAL_TLS_ROOTCAS=[/var/hyperledger/orderer/tls/ca.crt]
working_dir: /opt/gopath/src/github.com/hyperledger/fabric #指定容器的工作目錄
command: orderer # 容器啟動后默認執行的命令
volumes: # 將本地文件路徑映射到容器中的路徑之中
- ../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
ports: # 暴露端口信息
- 7050:7050
peer0.org1.example.com: # Org1的Peer0服務
container_name: peer0.org1.example.com
extends:
file: peer-base.yaml
service: peer-base
environment:
- CORE_PEER_ID=peer0.org1.example.com
- CORE_PEER_ADDRESS=peer0.org1.example.com:7051
- CORE_PEER_CHAINCODELISTENADDRESS=peer0.org1.example.com:7052
- CORE_PEER_GOSSIP_EXTERNALENDPOINT=peer0.org1.example.com:7051
- 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
ports:
- 7051:7051
- 7052:7052
- 7053:7053
peer1.org1.example.com: # Org1的Peer1服務
container_name: peer1.org1.example.com
extends:
file: peer-base.yaml
service: peer-base
environment:
- CORE_PEER_ID=peer1.org1.example.com
- CORE_PEER_ADDRESS=peer1.org1.example.com:7051
- CORE_PEER_CHAINCODELISTENADDRESS=peer1.org1.example.com:7052
- CORE_PEER_GOSSIP_EXTERNALENDPOINT=peer1.org1.example.com:7051
- CORE_PEER_GOSSIP_BOOTSTRAP=peer0.org1.example.com:7051
- CORE_PEER_LOCALMSPID=Org1MSP
volumes:
- /var/run/:/host/var/run/
- ../crypto-config/peerOrganizations/org1.example.com/peers/peer1.org1.example.com/msp:/etc/hyperledger/fabric/msp
- ../crypto-config/peerOrganizations/org1.example.com/peers/peer1.org1.example.com/tls:/etc/hyperledger/fabric/tls
ports:
- 8051:7051
- 8052:7052
- 8053:7053
peer0.org2.example.com: # Org2的Peer0服務
container_name: peer0.org2.example.com
extends:
file: peer-base.yaml
service: peer-base
environment:
- CORE_PEER_ID=peer0.org2.example.com
- CORE_PEER_ADDRESS=peer0.org2.example.com:7051
- CORE_PEER_CHAINCODELISTENADDRESS=peer0.org2.example.com:7052
- CORE_PEER_GOSSIP_EXTERNALENDPOINT=peer0.org2.example.com:7051
- CORE_PEER_LOCALMSPID=Org2MSP
volumes:
- /var/run/:/host/var/run/
- ../crypto-config/peerOrganizations/org2.example.com/peers/peer0.org2.example.com/msp:/etc/hyperledger/fabric/msp
- ../crypto-config/peerOrganizations/org2.example.com/peers/peer0.org2.example.com/tls:/etc/hyperledger/fabric/tls
ports:
- 9051:7051
- 9052:7052
- 9053:7053
peer1.org2.example.com: # Org1的Peer0服務
container_name: peer1.org2.example.com
extends:
file: peer-base.yaml
service: peer-base
environment:
- CORE_PEER_ID=peer1.org2.example.com
- CORE_PEER_ADDRESS=peer1.org2.example.com:7051
- CORE_PEER_CHAINCODELISTENADDRESS=peer1.org2.example.com:7052
- CORE_PEER_GOSSIP_EXTERNALENDPOINT=peer1.org2.example.com:7051
- CORE_PEER_GOSSIP_BOOTSTRAP=peer0.org2.example.com:7051
- CORE_PEER_LOCALMSPID=Org2MSP
volumes:
- /var/run/:/host/var/run/
- ../crypto-config/peerOrganizations/org2.example.com/peers/peer1.org2.example.com/msp:/etc/hyperledger/fabric/msp
- ../crypto-config/peerOrganizations/org2.example.com/peers/peer1.org2.example.com/tls:/etc/hyperledger/fabric/tls
ports:
- 10051:7051
- 10052:7052
- 10053:7053
三,Peer節點的配置文件 | peer-base.yaml
Peer的配置是在peer-base.yaml里面,與上面的結構基本詳細,因此在這里不做注釋。參照上面的注釋,應該就可以看懂了。其中的內容如下:
# Copyright IBM Corp. All Rights Reserved.
#
# SPDX-License-Identifier: Apache-2.0
#
version: '2'
services:
peer-base:
image: hyperledger/fabric-peer
environment:
- CORE_VM_ENDPOINT=unix:///host/var/run/docker.sock
# the following setting starts chaincode containers on the same
# bridge network as the peers
# https://docs.docker.com/compose/networking/
- CORE_VM_DOCKER_HOSTCONFIG_NETWORKMODE=e2ecli_default
#- CORE_LOGGING_LEVEL=ERROR
- CORE_LOGGING_LEVEL=DEBUG
- CORE_PEER_TLS_ENABLED=true
- CORE_PEER_GOSSIP_USELEADERELECTION=true
- CORE_PEER_GOSSIP_ORGLEADER=false
- CORE_PEER_PROFILE_ENABLED=true
- CORE_PEER_TLS_CERT_FILE=/etc/hyperledger/fabric/tls/server.crt
- CORE_PEER_TLS_KEY_FILE=/etc/hyperledger/fabric/tls/server.key
- CORE_PEER_TLS_ROOTCERT_FILE=/etc/hyperledger/fabric/tls/ca.crt
working_dir: /opt/gopath/src/github.com/hyperledger/fabric/peer
command: peer node start # 容器啟動之后,運行peer node start 命令開啟服務
四,CLI的配置文件 | docker-compose-cli.yaml
CLI的配置文件 | docker-compose-cli.yaml
CLI在整個Fabric網絡中扮演客戶端的角色,我們在開發測試的時候可以用CLI來代替SDK,執行各種SDK能執行的操作。CLI會和Peer相連,把指令發送給對應的Peer執行。
CLI的配置在docker-compose-cli.yaml中,接下來會對該文件進行注釋,文件內容如下:
# Copyright IBM Corp. All Rights Reserved.
#
# SPDX-License-Identifier: Apache-2.0
#
version: '2'
services: # Service根下,是該模板文件定義的所有服務
orderer.example.com: # Orderer服務
extends: # 基於其它模板進行擴展。
file: base/docker-compose-base.yaml # 進行拓展時使用的文件
service: orderer.example.com # 進行拓展時使用的服務
# 以上表示使用base/docker-compose-base.yaml中的orderer.example.com服務進行拓展
container_name: orderer.example.com
peer0.org1.example.com:
container_name: peer0.org1.example.com
extends:
file: base/docker-compose-base.yaml
service: peer0.org1.example.com
peer1.org1.example.com:
container_name: peer1.org1.example.com
extends:
file: base/docker-compose-base.yaml
service: peer1.org1.example.com
peer0.org2.example.com:
container_name: peer0.org2.example.com
extends:
file: base/docker-compose-base.yaml
service: peer0.org2.example.com
peer1.org2.example.com:
container_name: peer1.org2.example.com
extends:
file: base/docker-compose-base.yaml
service: peer1.org2.example.com
cli:
container_name: cli
image: hyperledger/fabric-tools
tty: true # 模擬一個假的遠程控制台。
environment:
- GOPATH=/opt/gopath
- CORE_VM_ENDPOINT=unix:///host/var/run/docker.sock
- CORE_LOGGING_LEVEL=DEBUG
- CORE_PEER_ID=cli
- CORE_PEER_ADDRESS=peer0.org1.example.com:7051
- 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
- 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
- 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
- CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp
working_dir: /opt/gopath/src/github.com/hyperledger/fabric/peer
command: /bin/bash -c './scripts/script.sh ${CHANNEL_NAME}; sleep $TIMEOUT'
volumes:
- /var/run/:/host/var/run/
- ../chaincode/go/:/opt/gopath/src/github.com/hyperledger/fabric/examples/chaincode/go
- ./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
container_name