创建链的配置文件和部署文件。
- rust: 1.59+
cargo install --path .
$ cloud-config -h
cloud-config 6.7.0
Rivtower Technologies <[email protected]>
Usage: cloud-config <COMMAND>
Commands:
init-chain init a chain
init-chain-config init chain config
set-admin set admin of chain
set-validators set validators of chain
append-validator append a validator into chain
set-nodelist set node list
append-node append a node into chain
delete-node delete a node from chain
init-node init node
update-node update node
delete-chain delete a chain
new-account new account
import-account import account
create-ca create CA
create-csr create csr
sign-csr sign csr
create-dev create config in env dev
append-dev append node in env dev
delete-dev delete node in env dev
create-k8s create config in env k8s
append-k8s append node in env k8s
delete-k8s delete node in env k8s
set-stage set stage
import-ca import ca
import-cert import node cert
update-yaml update k8s yaml
delete-validator delete a validator from chain
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
先前工具的实现方式是，通过用户传递的命令行参数，直接生成一条链所有节点的微服务配置文件。
这种实现方式有两个问题：
- 所有的逻辑混在一起。当需要针对不同的运行环境设置不同的配置逻辑时，会增加很多的分支判断，导致代码可维护性下降。比如，针对开发环境，需要在本地运行所有节点，因此需要各个节点的微服务端口不重复；而针对
k8s生产环境，则要求各个节点的微服务端口保持一致。 - 因为要同时传递一条链多个节点的信息，用户需要传递的参数非常多，心智负担比较大，非常容易出错。并且也不符合实际生产环境部署的时候，各个节点由不同参与方来提供信息的特点。
在新的实现中，抽象出链级配置和节点配置两个数据结构。链级配置包含一条链内所有节点都需要的公共信息；节点配置包含链内一个具体节点所需的信息。两个数据结构结合，包含了创建一条链所需的所有信息。
用户通过命令行参数传递的信息来填充这两个数据结构，然后据此产生出各个节点的所有配置文件。这样就分离了前端信息填充和后端生成配置文件。后续不管是优化前端用户输入信息的体验，还是在以后版本中配置文件结构有变化，都会比较容易修改，保证代码可维护性比较高。
用户通过命令行参数填充链级配置和节点配置的过程也被拆分成了多个子命令。一方面可以减少单个子命令的参数个数，另一方面整个过程更加灵活。可以适用于测试时集中生成的中心化模式，也可以适用于实际生产部署时，不同子命令由不同参与方执行的去中心化模式。
当前版本的配置项如下图所示：
mindmap
root((链配置))
id(链级配置)
id(genesis)
id[timestamp]
id[prevhash]
id(system_config)
id[version]
id[chain_id]
id[admin]
id[block_interval]
id[validators]
id[block_limit]
id[quota_limit]
id(node_network_address_list)
id[host]
id[port]
id[domain]
id[cluster]
id[svc_port]
id(micro_service_list)
id[image]
id[tag]
id(证书体系)
id[根证书]
id[节点证书]
id(节点配置)
id(grpc_ports)
id[port]
id(metrics_ports)
id[port]
id[network_listen_port]
id[log_level]
id[log_file_path]
id[jaeger_agent_endpoint]
id[account]
id[enable_metrics]
id[is_danger]
id(cloud_storage)
id[access_key_id]
id[secret_access_key]
id[endpoint]
id[bucket]
id[service_type]
id[root]
id(杂项)
id[config-dir]
id[chain_name]
将创建链配置的过程拆分成10个子命令和7个辅助的子命令，以实现最正规的去中心化配置流程。
7个辅助子命令为：
- create-ca创建链的根证书。会在
$(config-dir)/$(chain-name)/ca_cert/下生成cert.pem和key.pem两个文件。 - create-csr为各个节点创建证书和签名请求。会在
$(config-dir)/$(chain-name)/certs/$(domain)/下生成csr.pem和key.pem两个文件。 - sign-csr处理节点的签名请求。会在
$(config-dir)/$(chain-name)/certs/$(domain)/下生成cert.pem。 - new-account创建账户。会在
$(config-dir)/$(chain-name)/accounts/下，创建以账户地址为名的文件夹，里面有node_address，private_key，和validator_address三个文件。 - import-account导入私钥的方式创建账户。会在
$(config-dir)/$(chain-name)/accounts/下，创建以账户地址为名的文件夹，里面有node_address，private_key，和validator_address三个文件。 - import-ca导入已有的
CA证书。要求证书格式为pem，key的格式为pkcs8。 - import-cert导入已有的节点证书。要求证书格式为
pem，key的格式为pkcs8。
10个子命令分别为：
- init-chain。根据指定的
config-dir和chan-name,初始化一个链的文件目录结构。$(config_dir) -- $(chain_name) ------ accounts -------- .gitkeep ------ ca_cert -------- .gitkeep ------ certs -------- .gitkeep ------ .gitignore - init-chain-config。初始化除
admin(管理员账户)，validators(共识节点地址列表)，node_network_address_list（节点网络地址列表）之外的链级配置。因为前述三个操作需要一些额外的准备工作，且需要先对除此之外的链接配置信息在所有参与方之间达成共识。因此对于去中心化场景来说，这一步其实是一个公示的过程。执行之后会生成$(config-dir)/$(chain-name)/chain_config.toml - set-admin。设置管理员账户。账户需要事先通过new-account子命令创建。默认网络微服务为
network_zenoh，还需要通过create-ca创建链的根证书。 - set-validators。设置共识节点账户列表。账户同样需要事先通过new-account子命令，由各个共识节点分别创建，然后将账户地址集中到一起进行设置。
- set-nodelist。设置节点网络地址列表。各个节点参与方需要根据自己的网络环境，预先保留节点的
ip，port和domain。然后将相关信息集中到一起进行设置。至此，链级配置信息设置完成，可以下发配置文件chain_config.toml到各个节点。默认网络微服务为network_zenoh，则需要通过create-csr根据节点的domain为各个节点创建证书和签名请求。然后请求CA通过sign-crs处理签名请求，并下发生成的cert.pem到各个节点。 - set-stage设置链配置进行到的阶段。将链的配置过程分为三个阶段，分别为
init，public和finalize，一些子命令会根据当前所处的阶段，来判断是否可以进行操作，以避免一些误操作。init-chain-config初始化链的配置时，默认设置阶段为init，该阶段可以重复进行init-chain-config以修改链的基础配置；set-admin只能在init阶段执行，并且会自动将阶段修改为public；append-validator，delete-validator和set-validators只能在public阶段进行；此后需要手工执行该命令将阶段修改为finalize，此时链的配置完成，不能再修改除节点网络地址列表之外的配置，并且此后才可以进行init-node操作。辅助命令和delete-chain不受阶段的限制。 - init-node。设置
节点配置信息。这步操作由各个节点的参与方独立设置，节点之间可以不同。执行之后会生成$(config-dir)/$(chain-name)-$(domain)/node_config.toml - update-node。根据之前设置的
链级配置和节点配置，生成每个节点所需的微服务配置文件。 - update-yaml。根据之前设置的
链级配置和节点配置，生成每个节点部署到k8s环境所需的资源文件。 - delete-chain删除链。删除属于该链的所有文件夹以及其中的文件，
使用时要慎重。
此外还有一些其他操作的子命令。
比如增加单个共识节点的append-validator，删除单个共识节点的delete-validator；增加单个网络节点的append-node，删除单个网络节点的delete-node。
在前述流程的基础上，封装了更高级更方便使用的子命令。
比如针对开发环境，有create-dev，append-dev和delete-dev，使用开发环境约定好的默认值，无需执行这么多子命令，也无需传递大量参数就可以生成和操作一条链的配置。
针对演示或者生产阶段的k8s环境，有create-k8s，append-k8s和delete-k8s。
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
$ cloud-config init-chain
$ tree -a test-chain/
test-chain/
├── .gitignore
├── accounts
│ └── .gitkeep
├── ca_cert
│ └── .gitkeep
└── certs
└── .gitkeep
参数：
--chain-name <CHAIN_NAME>
set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
set config file directory, default means current directory [default: .]
--timestamp <TIMESTAMP>
set genesis timestamp [default: 0]
--prevhash <PREVHASH>
set genesis prevhash [default: 0x0000000000000000000000000000000000000000000000000000000000000000]
--version <VERSION>
set system config version [default: 0]
--chain_id <CHAIN_ID>
set system config chain_id [default: ]
--block_interval <BLOCK_INTERVAL>
set system config block_interval [default: 3]
--block_limit <BLOCK_LIMIT>
set system config block_limit [default: 100]
--quota-limit <QUOTA_LIMIT>
set one block contains quota limit, default 1073741824 [default: 1073741824]
--network_image <NETWORK_IMAGE>
set network micro service image name (network_zenoh) [default: network_zenoh]
--network_tag <NETWORK_TAG>
set network micro service image tag [default: latest]
--consensus_image <CONSENSUS_IMAGE>
set consensus micro service image name (consensus_raft/consensus_overlord) [default: consensus_overlord]
--consensus_tag <CONSENSUS_TAG>
set consensus micro service image tag [default: latest]
--executor_image <EXECUTOR_IMAGE>
set executor micro service image name (executor_evm) [default: executor_evm]
--executor_tag <EXECUTOR_TAG>
set executor micro service image tag [default: latest]
--storage_image <STORAGE_IMAGE>
set storage micro service image name (storage_opendal) [default: storage_opendal]
--storage_tag <STORAGE_TAG>
set storage micro service image tag [default: latest]
--controller_image <CONTROLLER_IMAGE>
set controller micro service image name (controller) [default: controller]
--controller_tag <CONTROLLER_TAG>
set controller micro service image tag [default: latest]
说明：
- 参数部分基本对应
链级配置数据结构，具体含义参见设计部分的描述。
$ cloud-config init-chain-config
$ tree test-chain/
test-chain/
├── accounts
├── ca_cert
├── certs
└── chain_config.toml
$ cat test-chain/chain_config.toml
node_network_address_list = []
stage = 'Init'
[[micro_service_list]]
image = 'network_zenoh'
tag = 'latest'
[[micro_service_list]]
image = 'consensus_overlord'
tag = 'latest'
[[micro_service_list]]
image = 'executor_evm'
tag = 'latest'
[[micro_service_list]]
image = 'storage_opendal'
tag = 'latest'
[[micro_service_list]]
image = 'controller'
tag = 'latest'
[genesis_block]
prevhash = '0x0000000000000000000000000000000000000000000000000000000000000000'
timestamp = 1649418157966
[system_config]
admin = ''
block_interval = 3
block_limit = 100
chain_id = '63586a3c0255f337c77a777ff54f0040b8c388da04f23ecee6bfd4953a6512b4'
quota_limit = 1073741824
validators = []
version = 0
说明：
timestamp默认参数为0。检测到为默认值时，自动替换为当前时间对应的时间戳。chain_id默认为空字符串。检测到为默认值时，自动替换为hex(sm3($(chain_name)))。
参数：
--chain-name <CHAIN_NAME>
set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
set config file directory, default means current directory [default: .]
$ cloud-config new-account
node_address: 29b4da67ecb5591f1c5cfba6509142678d266e79 validator_address: a14bbda941cb707e1979ad96a01bf5b25c0916805cde2c4d418e8831ab57df186174c32d765aa6f0da4c686c258ff5d1
$ cloud-config new-account
node_address: 5bf591636c7efc27cd855c2282a1652bfa14a1bc validator_address: b2a2f83851454504f66d20846c48dc1f6fbe71d0b7ba89b5b9483ca7417be3bd86a75b64e7fa5b13d0ef8f80a4c14a69
$ tree test-chain
test-chain/
├── .gitignore
├── accounts
│ ├── .gitkeep
│ ├── 29b4da67ecb5591f1c5cfba6509142678d266e79
│ │ ├── node_address
│ │ ├── private_key
│ │ └── validator_address
│ └── 5bf591636c7efc27cd855c2282a1652bfa14a1bc
│ ├── node_address
│ ├── private_key
│ └── validator_address
├── ca_cert
│ └── .gitkeep
├── certs
│ └── .gitkeep
└── chain_config.toml
说明：
- 这里会创建两个地址，一个用于标识节点的
node_address，一个用于共识validator的validator_address。 - 默认情况下两个地址是不一样的。但是当共识微服务选择
consensus_raft时两者是一样的，注意区分。
参数：
--chain-name <CHAIN_NAME>
set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
set config file directory, default means current directory [default: .]
--privkey <PRIVKEY>
hex encoded private key
$ cloud-config import-account --privkey 60e7b47ee260516dbfedf8e80ff38830bae8663cc498a900a610c147cae94344
node_address: 097913007f2c8d9ac87f89664fc70977fee6bf9a validator_address: 965e7f200043a8ae543478330faf1c751f4c4d8040f93a7d0b8881085b8583bea6f7166ddc0c5bb9adff8563f7b3cbd2
$ tree test-chain/
test-chain/
├── accounts
│ └── 097913007f2c8d9ac87f89664fc70977fee6bf9a
│ ├── node_address
│ ├── private_key
│ └── validator_address
├── ca_cert
├── certs
└── chain_config.toml
说明：
- 这里会创建两个地址，一个用于标识节点的
node_address，一个用于共识validator的validator_address。 - 默认情况下两个地址是不一样的。但是当共识微服务选择
consensus_raft时两者是一样的，注意区分。
参数：
--admin <ADMIN> set admin
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
说明：
admin为必选参数。值为之前用new-account创建的node_address地址。
$ cloud-config set-admin --admin aeaa6e333b8ed911f89acd01e88e3d9892da87b5
$ cat test-chain/chain_config.toml | grep admin
admin = 'aeaa6e333b8ed911f89acd01e88e3d9892da87b5'
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--validators <VALIDATORS> validators account splited by ','
说明：
validators为必选参数。值为多个之前用new-account创建的validator_address地址,用逗号分隔。
$ cloud-config set-validators --validators a14bbda941cb707e1979ad96a01bf5b25c0916805cde2c4d418e8831ab57df186174c32d765aa6f0da4c686c258ff5d1,b2a2f83851454504f66d20846c48dc1f6fbe71d0b7ba89b5b9483ca7417be3bd86a75b64e7fa5b13d0ef8f80a4c14a69
$ cat test-chain/chain_config.toml | grep -A3 validators
validators = [
"a14bbda941cb707e1979ad96a01bf5b25c0916805cde2c4d418e8831ab57df186174c32d765aa6f0da4c686c258ff5d1",
"b2a2f83851454504f66d20846c48dc1f6fbe71d0b7ba89b5b9483ca7417be3bd86a75b64e7fa5b13d0ef8f80a4c14a69",
]
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--validator <VALIDATOR> validator account
说明：
validator为必选参数。值为之前用new-account创建的validator_address地址。- 功能与
set-validators相似，只不过是每次添加一个地址。
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--validator <VALIDATOR> validator account
说明：
validator为必选参数。要删除的共识账户地址。- 功能与
append-validator相反，删除一个共识账户。
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--stage <STAGE> set stage init/public/finalize [default: finalize]
说明：
stage为要设置的阶段名称。默认值为finalize，因为其他两个阶段会随着子命令自动变迁，正常情况下只有finalize需要手工设置。各阶段的详细含义参见设计部分的描述。- 只有确定过了某个阶段才发现前一个阶段的信息还需要修改，才需要回溯阶段。随意回溯阶段，可能会导致配置被不合理的修改，请谨慎操作。
$ cat test-chain/chain_config.toml | grep stage
stage = 'Public'
$ cloud-config set-stage
$ cat test-chain/chain_config.toml | grep stage
stage = 'Finalize'
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--nodelist <NODE_LIST> node list looks like
localhost:40000:node0:k8s_cluster1,localhost:40001:node1:k8s_cluster2
last slice is optional, none means not k8s env
说明：
nodelist为必选参数。值为多个节点的网络地址,用逗号分隔。每个节点的网络地址包含ip,port，domain，cluster name，之间用分号分隔。cluster name是节点所在的k8s集群的名称。出于兼容性考虑，非k8s环境该项可以省略，会自动生成一个随机的集群名称。domain为任意字符串，只需要确保节点之间不重复即可。
$ cloud-config set-nodelist --nodelist localhost:40000:node0,localhost:40001:node1
$ cat test-chain/chain_config.toml | grep -A5 node_network
[[node_network_address_list]]
cluster = 'aaIOppLx'
domain = 'node0'
host = 'localhost'
port = 40000
svc_port = 40000
--
[[node_network_address_list]]
cluster = 'xwIaqkcX'
domain = 'node1'
host = 'localhost'
port = 40001
svc_port = 40000
$ cloud-config set-nodelist --nodelist localhost:40000:node0:k8s_cluster1,localhost:40001:node1:k8s_cluster2
$ cat test-chain/chain_config.toml | grep -A5 node_network
[[node_network_address_list]]
cluster = 'k8s_cluster1'
domain = 'node0'
host = 'localhost'
port = 40000
svc_port = 40000
--
[[node_network_address_list]]
cluster = 'k8s_cluster2'
domain = 'node1'
host = 'localhost'
port = 40001
svc_port = 40000
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--node <NODE> node network address looks like
localhost:40002:node2:k8s_cluster1 last slice is optional, none
means not k8s env
node为必选参数。值为节点的网络地址,包含ip,port，domain，cluster name。cluster name是节点所在的k8s集群的名称。出于兼容性考虑，非k8s环境该项可以省略，会自动生成一个随机的集群名称。- 功能与
set-nodelist相似，只不过是每次添加一个节点。
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--domain <DOMAIN> domain of node that want to delete
domain为必选参数。作为节点的标识，标识要删除的节点。- 功能与
append-node相反，删除一个节点。
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
$ cloud-config create-ca
$ tree test-chain
test-chain
├── accounts
├── ca_cert
│ ├── cert.pem
│ └── key.pem
├── certs
└── chain_config.toml
说明：
- 该命令生成文件形式的根证书，存放在
ca_cert目录下。
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--domain <DOMAIN> domain of node
说明：
domain为必选参数。值为前面set-nodelist或者append-node时传递的节点的网络地址中的domain。- 证书中真正使用的
domain是$(chain-name)-$(domain)。
$ cloud-config create-csr --domain node0
$ cloud-config create-csr --domain node1
$ tree test-chain
test-chain
├── accounts
├── ca_cert
│ ├── cert.pem
│ └── key.pem
├── certs
│ ├── node0
│ │ ├── csr.pem
│ │ └── key.pem
│ └── node1
│ ├── csr.pem
│ └── key.pem
└── chain_config.toml
说明：
- 该命令生成节点的私钥和签名请求，存放在
certs目录下。 - 每个节点的文件都在以节点
domain为文件名的子文件夹内。
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--domain <DOMAIN> domain of node
说明：
domain为必选参数。值为前面执行create-csr时节点的domain。
$ cloud-config sign-csr --domain node0
$ cloud-config sign-csr --domain node1
$ tree test-chain
test-chain
├── accounts
├── ca_cert
│ ├── cert.pem
│ └── key.pem
└── certs
│ ├── node0
│ │ ├── cert.pem
│ │ ├── csr.pem
│ │ └── key.pem
│ └── node1
│ ├── cert.pem
│ ├── csr.pem
│ └── key.pem
└── chain_config.toml
说明：
- 该命令生成节点的证书文件
cert.pem，存放在certs目录下。 - 每个节点的文件都在以节点
domain为文件名的子文件夹内。
参数：
--ca-cert <CA_CERT_PATH> set path of ca cert file(pem)
--ca-key <CA_KEY_PATH> set path of ca key file(pem)
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
说明：
ca-cert为必选参数。为要导入的CA证书文件路径，格式为pem。ca-key为必选参数。为要导入的CA证书key文件路径，格式为pem，并且编码格式为pkcs8。
参数：
--cert <CERT_PATH> set path of cert file(pem)
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--domain <DOMAIN> domain of node
--key <KEY_PATH> set path of key file(pem)
说明：
domain为必选参数。值为前面set-nodelist或者append-node时传递的节点的网络地址中的domain。cert为必选参数。为要导入的节点证书文件路径，格式为pem。key为必选参数。为要导入的节点证书key文件路径，格式为pem，并且编码格式为pkcs8。
参数：
--chain-name <CHAIN_NAME>
set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
set config file directory, default means current directory [default: .]
--domain <DOMAIN>
domain of node
--network-port <NETWORK_PORT>
grpc network_port of node [default: 50000]
--consensus-port <CONSENSUS_PORT>
grpc consensus_port of node [default: 50001]
--executor-port <EXECUTOR_PORT>
grpc executor_port of node [default: 50002]
--storage-port <STORAGE_PORT>
grpc storage_port of node [default: 50003]
--controller-port <CONTROLLER_PORT>
grpc controller_port of node [default: 50004]
--network-listen-port <NETWORK_LISTEN_PORT>
network listen port of node [default: 40000]
--log-level <LOG_LEVEL>
log level [default: info]
--log-file-path <LOG_FILE_PATH>
log file path
--jaeger-agent-endpoint <JAEGER_AGENT_ENDPOINT>
jaeger agent endpoint
--account <ACCOUNT>
account of node
--network-metrics-port <NETWORK_METRICS_PORT>
network metrics port of node [default: 60000]
--consensus-metrics-port <CONSENSUS_METRICS_PORT>
consensus metrics port of node [default: 60001]
--executor-metrics-port <EXECUTOR_METRICS_PORT>
executor metrics port of node [default: 60002]
--storage-metrics-port <STORAGE_METRICS_PORT>
storage metrics port of node [default: 60003]
--controller-metrics-port <CONTROLLER_METRICS_PORT>
controller metrics port of node [default: 60004]
--disable-metrics
disable metrics
--is-danger
is chain in danger mode
--access-key-id <ACCESS_KEY_ID>
cloud_storage.access_key_id [default: ]
--secret-access-key <SECRET_ACCESS_KEY>
cloud_storage.secret_access_key [default: ]
--s3-endpoint <S3_ENDPOINT>
cloud_storage.endpoint [default: ]
--s3-bucket <S3_BUCKET>
cloud_storage.bucket [default: ]
--service-type <SERVICE_TYPE>
cloud_storage.service_type: s3/oss(aliyun)/obs(huawei)/cos(tencent)/azblob(azure) [default: ]
--s3-root <S3_ROOT>
cloud_storage.root [default: ]
说明：
- 参数部分基本对应
节点配置数据结构，具体含义参见设计部分的描述。 domain为必选参数，作为节点的标识，节点文件夹将会以$(chanin-name)-$(domain)的形式命名。account为必选参数，表示该节点要使用的账户地址。值为之前用new-account创建的node_address地址。
$ cloud-config init-node --domain node0 --account 5bf591636c7efc27cd855c2282a1652bfa14a1bc
$ cloud-config init-node --domain node1 --account 29b4da67ecb5591f1c5cfba6509142678d266e79
$ tree test-chain-node*
test-chain-node0
├── accounts
├── ca_cert
├── certs
├── chain_config.toml
└── node_config.toml
test-chain-node1
├── accounts
├── ca_cert
├── certs
├── chain_config.toml
└── node_config.toml
$ cat test-chain-node0/node_config.toml
account = "5bf591636c7efc27cd855c2282a1652bfa14a1bc"
enable_metrics = true
is_danger = false
log_level = "info"
network_listen_port = 40000
[cloud_storage]
access_key_id = ""
bucket = ""
endpoint = ""
root = ""
secret_access_key = ""
service_type = ""
[grpc_ports]
consensus_port = 50001
controller_port = 50004
executor_port = 50002
network_port = 50000
storage_port = 50003
[metrics_ports]
consensus_metrics_port = 60001
controller_metrics_port = 60004
executor_metrics_port = 60002
network_metrics_port = 60000
storage_metrics_port = 60003
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--config-name <CONFIG_NAME> set config file name [default: config.toml]
--domain <DOMAIN> domain of node
--is-dev is for dev env
--no-stdout disable output to stdout
说明：
domain为必选参数，作为节点的标识，表示要操作的节点。is-dev用于区别是dev环境，亦或k8s环境。
$ cloud-config update-node --domain node0
$ cloud-config update-node --domain node1
$ tree test-chain-node*
test-chain-node0
├── chain_config.toml
├── config.toml
├── node_address
├── node_config.toml
├── private_key
└── validator_address
test-chain-node1
├── chain_config.toml
├── config.toml
├── node_address
├── node_config.toml
├── private_key
└── validator_address
参数：
--chain-name <CHAIN_NAME>
set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
set config file directory, default means current directory [default: .]
--config-name <CONFIG_NAME>
set config file name [default: config.toml]
--domain <DOMAIN>
domain of node
--pull-policy <PULL_POLICY>
image pull policy: IfNotPresent or Always [default: IfNotPresent]
--docker-registry <DOCKER_REGISTRY>
docker registry [default: docker.io]
--docker-repo <DOCKER_REPO>
docker repo [default: citacloud]
--storage-class <STORAGE_CLASS>
storage class
--access-mode <ACCESS_MODE>
pvc access mode: ReadWriteOnce/ReadWriteMany [default: ReadWriteMany]
--storage-capacity <STORAGE_CAPACITY>
storage capacity [default: 10Gi]
--requests-cpu <REQUESTS_CPU>
container resource requirements -- requests cpu [default: 10m]
--requests-memory <REQUESTS_MEMORY>
container resource requirements -- requests memory [default: 32Mi]
--limits-cpu <LIMITS_CPU>
container resource requirements -- limits cpu [default: 4000m]
--limits-memory <LIMITS_MEMORY>
container resource requirements -- limits memory [default: 8192Mi]
--enable-debug
is enable debug
--disable-health-check
is disable health-check
--enable-kustomize
is gen kustomization
说明：
domain为必选参数，作为节点的标识，表示要操作的节点。storage-class为必选参数，指定节点在k8s集群中的持久化存储使用的存储类。limits-cpu,limits-memory,requests-cpu,requests-memory用于设定微服务的硬件资源需求。请根据实际运行环境的硬件配置进行调整，以获得最佳性能体验。enable-kustomize开启之后会在节点目录下生成kustomization相关的文件，方便修改基础环境相关的配置而不用重新生成节点配置文件。保留原来的用法(kubectl apply -f test-chain-node0/yamls)不变，增加新的用法(kubectl apply -k test-chain-node0)。
$ cloud-config update-yaml --domain node0 --storage-class nfs-client
$ ls test-chain-node0/yamls
cm-account.yaml cm-config.yaml cm-log.yaml node-svc.yaml statefulset.yaml
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
说明：
- 该命令会删除所有跟指定链相关的文件夹及文件，
使用时要慎重。
约定：
- 节点的
ip都为localhost。 - 节点的网络端口从
40000开始往后顺延。 - 节点的
domain使用节点的序号。 - 节点各个微服务的
gRPC端口从50000 + i*1000开始往后顺延。其中i为节点的序号。 - 节点各个微服务的
metrics exporter端口从60000 + i*100开始往后顺延。其中i为节点的序号。 - 增加节点只能在最大的节点序号往后增加。
- 删除节点也只能从最大的节点序号开始往前删除。
适用于开发阶段，在单机非容器环境直接跑链进行测试。
参数：
$ cloud-config create-dev -h
create config in env dev
Usage: cloud-config create-dev [OPTIONS]
Options:
--chain-name <CHAIN_NAME>
set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
set config file directory, default means current directory [default: .]
--peers-count <PEERS_COUNT>
set initial node number [default: 4]
--log-level <LOG_LEVEL>
log level [default: info]
--log-file-path <LOG_FILE_PATH>
log file path [default: ./logs]
--jaeger-agent-endpoint <JAEGER_AGENT_ENDPOINT>
jaeger agent endpoint
--is-raft
is consensus raft
--is-danger
is chain in danger mode
--disable-metrics
disable metrics
--access-key-id <ACCESS_KEY_ID>
cloud_storage.access_key_id [default: ]
--secret-access-key <SECRET_ACCESS_KEY>
cloud_storage.secret_access_key [default: ]
--s3-endpoint <S3_ENDPOINT>
cloud_storage.endpoint [default: ]
--s3-bucket <S3_BUCKET>
cloud_storage.bucket [default: ]
--service-type <SERVICE_TYPE>
cloud_storage.service_type: s3/oss(aliyun)/obs(huawei)/cos(tencent)/azblob(azure) [default: ]
--s3-root <S3_ROOT>
cloud_storage.root [default: ]
-h, --help
Print help
说明：
--is-raft标识consensus微服务是否选择了consensus_raft。
$ cloud-config create-dev
node_address: bde21c1bcc73817c8af033e37bf3177bff7be1e1 validator_address: a9714aa3f9ac195602fac77baf6b4a42a7d8508fe8db722633e652216fd4c3af2eda15a5eceb85a4c0046e64cda40060
node_address: 3c3965e120b0399bda0be0b68f9569520f13ef26 validator_address: 8804bca2e919d9e487d05d88e447c488fa51f74ad1171a5dcba5cdcdf7e72c0a605d97697f3189a23ba11a0f83af560e
node_address: 3dbd135e3fedb84db5fa95e256d5d650196bed91 validator_address: b418e9dc46731dca35bad2296ac15e788c5eee84ce3c0fcb108158cd78e0bc9cca75e00c7a0e76dca8ea7c5d0240c6bc
node_address: 9be90a72f73f9ab6d03278545fe6fa26244c8e90 validator_address: adb23083ce21e1c86d864bfa708689c13495e26484d1a9ba6b0462808dd1c689251767d81ef9e4b28091290baafd81e1
node_address: bc822df3270b5bc22453f7b43aad01cd55dc12f4 validator_address: a3871975a50261f803f362515ffbb1324538cd6ea6fa53c8bb3ae6627d78bdefe39d5e06ab9985b7d237713cfdcb756c
$ ls test-chain-*
test-chain-0:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-1:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-2:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-3:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
参数：
$ cloud-config append-dev -h
append node in env dev
Usage: cloud-config append-dev [OPTIONS]
Options:
--chain-name <CHAIN_NAME>
set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
set config file directory, default means current directory [default: .]
--log-level <LOG_LEVEL>
log level [default: info]
--log-file-path <LOG_FILE_PATH>
log file path
--jaeger-agent-endpoint <JAEGER_AGENT_ENDPOINT>
jaeger agent endpoint
--is-danger
is chain in danger mode
--disable-metrics
disable metrics
--access-key-id <ACCESS_KEY_ID>
cloud_storage.access_key_id [default: ]
--secret-access-key <SECRET_ACCESS_KEY>
cloud_storage.secret_access_key [default: ]
--s3-endpoint <S3_ENDPOINT>
cloud_storage.endpoint [default: ]
--s3-bucket <S3_BUCKET>
cloud_storage.bucket [default: ]
--service-type <SERVICE_TYPE>
cloud_storage.service_type: s3/oss(aliyun)/obs(huawei)/cos(tencent)/azblob(azure) [default: ]
--s3-root <S3_ROOT>
cloud_storage.root [default: ]
-h, --help
Print help
$ cloud-config append-dev
node_address: 021dcd4e8f1607840337eaf51d345d88366b4693 validator_address: a2607ccc77e15ec4629a0875cfac42dc1465dc10808d0d840ede9ee93c75dc65897cdda5d3bb899ad351945016b68662
$ ls test-chain-*
test-chain-0:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-1:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-2:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-3:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-4:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
参数：
$ cloud-config delete-dev -h
cloud-config-delete-dev
delete node in env dev
USAGE:
cloud-config delete-dev [OPTIONS]
OPTIONS:
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
-h, --help Print help information
$ cloud-config delete-dev
$ ls test-chain-*
test-chain-0:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-1:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-2:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-3:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
约定：
- 超级管理员账户由用户自行创建并通过参数传入。
- 节点各个微服务的
gRPC端口固定从50000开始依次分配给各微服务。 - 节点各个微服务的
metrics exporter端口固定从60000依次分配给各微服务。 - 节点的网络监听端口固定为
40000。
适用于演示或者生产阶段，在k8s环境部署链。
参数：
--chain-name <CHAIN_NAME>
set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
set config file directory, default means current directory [default: .]
--timestamp <TIMESTAMP>
set genesis timestamp [default: 0]
--prevhash <PREVHASH>
set genesis prevhash [default: 0x0000000000000000000000000000000000000000000000000000000000000000]
--version <VERSION>
set system config version [default: 0]
--chain_id <CHAIN_ID>
set system config chain_id [default: ]
--block_interval <BLOCK_INTERVAL>
set system config block_interval [default: 3]
--block_limit <BLOCK_LIMIT>
set system config block_limit [default: 100]
--quota-limit <QUOTA_LIMIT>
set one block contains quota limit, default 1073741824 [default: 1073741824]
--network_image <NETWORK_IMAGE>
set network micro service image name (network_zenoh) [default: network_zenoh]
--network_tag <NETWORK_TAG>
set network micro service image tag [default: latest]
--consensus_image <CONSENSUS_IMAGE>
set consensus micro service image name (consensus_raft/consensus_overlord) [default: consensus_overlord]
--consensus_tag <CONSENSUS_TAG>
set consensus micro service image tag [default: latest]
--executor_image <EXECUTOR_IMAGE>
set executor micro service image name (executor_evm) [default: executor_evm]
--executor_tag <EXECUTOR_TAG>
set executor micro service image tag [default: latest]
--storage_image <STORAGE_IMAGE>
set storage micro service image name (storage_opendal) [default: storage_opendal]
--storage_tag <STORAGE_TAG>
set storage micro service image tag [default: latest]
--controller_image <CONTROLLER_IMAGE>
set controller micro service image name (controller) [default: controller]
--controller_tag <CONTROLLER_TAG>
set controller micro service image tag [default: latest]
--admin <ADMIN>
set admin
--nodelist <NODE_LIST>
node list looks like localhost:40000:node0:k8s_cluster1,localhost:40001:node1:k8s_cluster2 last slice is optional, none means not k8s env
--log-level <LOG_LEVEL>
log level [default: info]
--log-file-path <LOG_FILE_PATH>
log file path
--jaeger-agent-endpoint <JAEGER_AGENT_ENDPOINT>
jaeger agent endpoint
--is-danger
is chain in danger mode
--disable-metrics
disable metrics
--access-key-id <ACCESS_KEY_ID>
cloud_storage.access_key_id [default: ]
--secret-access-key <SECRET_ACCESS_KEY>
cloud_storage.secret_access_key [default: ]
--s3-endpoint <S3_ENDPOINT>
cloud_storage.endpoint [default: ]
--s3-bucket <S3_BUCKET>
cloud_storage.bucket [default: ]
--service-type <SERVICE_TYPE>
cloud_storage.service_type: s3/oss(aliyun)/obs(huawei)/cos(tencent)/azblob(azure) [default: ]
--s3-root <S3_ROOT>
cloud_storage.root [default: ]
说明:
admin为必选参数。使用用户事先创建好的超级管理员账户地址。nodelist为必选参数。值为多个节点的网络地址,用逗号分隔。每个节点的网络地址包含ip,port，domain，cluster name，之间用分号分隔。cluster name是节点所在的k8s集群的名称。出于兼容性考虑，非k8s环境该项可以省略，会自动生成一个随机的集群名称。
$ cloud-config create-k8s --admin 0xff8456931c10a9b02ec4a657ee05e724ecad9372 --nodelist localhost:40000:node0:k8s,localhost:40001:node1:k8s
node_address: 7585747d549aeb4717504275e71daa23b540bf3d validator_address: a338859941e202548af9200ab82697f3d78f22924c640eb3f6b207718f0a99abfda21c65a0ffa8bcac055ac38358469a
node_address: 517cf02e4735135331d211c84bf2114c8607299c validator_address: 95ef7dabc79069b485a8ae478cc791674325f9f8bbbd15bfa8e6087d5eb2e2cdabbef4e92a24d6b62696dd111e2afded
$ ls test-chain-node*
test-chain-node0:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-node1:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
参数：
--chain-name <CHAIN_NAME>
set chain name [default: test-chain]
--config-dir <CONFIG_DIR>
set config file directory, default means current directory [default: .]
--log-level <LOG_LEVEL>
log level [default: info]
--log-file-path <LOG_FILE_PATH>
log file path
--jaeger-agent-endpoint <JAEGER_AGENT_ENDPOINT>
jaeger agent endpoint
--node <NODE>
node network address looks like localhost:40002:node2:k8s_cluster1 last slice is optional, none means not k8s env
--is-danger
is chain in danger mode
--disable-metrics
disable metrics
--access-key-id <ACCESS_KEY_ID>
cloud_storage.access_key_id [default: ]
--secret-access-key <SECRET_ACCESS_KEY>
cloud_storage.secret_access_key [default: ]
--s3-endpoint <S3_ENDPOINT>
cloud_storage.endpoint [default: ]
--s3-bucket <S3_BUCKET>
cloud_storage.bucket [default: ]
--service-type <SERVICE_TYPE>
cloud_storage.service_type: s3/oss(aliyun)/obs(huawei)/cos(tencent)/azblob(azure) [default: ]
--s3-root <S3_ROOT>
cloud_storage.root [default: ]
说明：
node为必选参数。值为节点的网络地址,包含ip,port，domain，cluster name。cluster name是节点所在的k8s集群的名称。出于兼容性考虑，非k8s环境该项可以省略。
$ cloud-config append-k8s --node localhost:40002:node2:k8s
node_address: b6f2210e63331458f00a0aee58b83ddee1c36e83 validator_address: 9860b8a49b7f2016e1cfe3fe9dc053915cab92a8d58c9ab3082049fce949bb3c586ec2cf5c1590ab2c91884a0446cb69
$ ls test-chain-node*
test-chain-node0:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-node1:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-node2:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
参数：
--chain-name <CHAIN_NAME> set chain name [default: test-chain]
--config-dir <CONFIG_DIR> set config file directory, default means current directory
[default: .]
--domain <DOMAIN> domain of node that want to delete
说明：
domain为必选参数。值为要删除节点的标识，与创建链和增加节点时的domain保持一致。
$ cloud-config delete-k8s --domain node2
$ ls test-chain-node*
test-chain-node0:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address
test-chain-node1:
accounts ca_cert certs chain_config.toml config.toml node_address node_config.toml private_key validator_address