etcd命令说明 etcd Version: 3.0.15

Posted 2020-08-25 doscho

etcd Version: 3.0.15
Git SHA: fc00305
Go Version: go1.6.3
Go OS/Arch: linux/amd64

 

usage: etcd [flags]
　　　　start an etcd server

　　　　etcd --version
　　　　　　show the version of etcd

　　　　etcd -h | --help
　　　　　　show the help information about etcd

　　　　etcd --config-file
　　　　　　path to the server configuration file

member flags:

　　　　--name ‘default‘
　　　　　　human-readable name for this member.
　　　　--data-dir ‘${name}.etcd‘
　　　　　　path to the data directory.
　　　　--wal-dir ‘‘
　　　　　　path to the dedicated wal directory.
　　　　--snapshot-count ‘10000‘
　　　　　　number of committed transactions to trigger a snapshot to disk.
　　　　--heartbeat-interval ‘100‘
　　　　　　time (in milliseconds) of a heartbeat interval.
　　　　--election-timeout ‘1000‘
　　　　　　time (in milliseconds) for an election to timeout. See tuning documentation for details.
　　　　--listen-peer-urls ‘http://localhost:2380‘　　　　etcd作为分布式节点通信端口 ，支持多个rul ， ‘http://localhost:2380, http://localhost:7001‘
　　　　　　list of URLs to listen on for peer traffic.  　　
　　　　--listen-client-urls ‘http://localhost:2379‘　　　 客户端操作etcd API的端口
　　　　　　list of URLs to listen on for client traffic.　　　如果服务启动时，设置了--listen-client-urls，需要设置 --advertise-client-urls
　　　　--max-snapshots ‘5‘
　　　　　　maximum number of snapshot files to retain (0 is unlimited).
　　　　--max-wals ‘5‘
　　　　　　maximum number of wal files to retain (0 is unlimited).
　　　　--cors ‘‘
　　　　　　comma-separated whitelist of origins for CORS (cross-origin resource sharing).
　　　　--quota-backend-bytes ‘0‘
　　　　　　raise alarms when backend size exceeds the given quota (0 defaults to low space quota).

clustering flags:

　　　　--initial-advertise-peer-urls ‘http://localhost:2380‘                 作为集群中的peer接口，如果启动服务时，设置了--initial-advertise-peer-urls， 需要设置--initial-cluster
　　　　　　list of this member‘s peer URLs to advertise to the rest of the cluster.
　　　　--initial-cluster ‘default=http://localhost:2380‘　　　　　　　　STATIC 初始化集群，内容是advertised peer URLs,　与各个节点的 initial-advertise-peer-urls 匹配。　 
　　　　　　initial cluster configuration for bootstrapping.
　　　　--initial-cluster-state ‘new‘
　　　　　　initial cluster state (‘new‘ or ‘existing‘).
　　　　--initial-cluster-token ‘etcd-cluster‘　　　　　　　　　　　　　　通过设置etcd集群的token，生成不同的集群ID和memberid，区别其他群。当系统中有多个集群时。
　　　　　　initial cluster token for the etcd cluster during bootstrap.
　　　　　　Specifying this can protect you from unintended cross-cluster interaction when running multiple clusters.
　　　　--advertise-client-urls ‘http://localhost:2379‘　　　　　　　　 作为分布式的客户端连接端口 for  member to other member、proxy、 client in cluster。 　　　
　　　　　　list of this member‘s client URLs to advertise to the public.
　　　　　　The client URLs advertised should be accessible to machines that talk to etcd cluster. etcd client libraries parse these URLs to connect to the cluster.
　　　　--discovery ‘‘
　　　　　　discovery URL used to bootstrap the cluster.
　　　　--discovery-fallback ‘proxy‘
　　　　　　expected behavior (‘exit‘ or ‘proxy‘) when discovery services fails.
　　　　　　"proxy" supports v2 API only.
　　　　--discovery-proxy ‘‘
　　　　　　HTTP proxy to use for traffic to discovery service.
　　　　--discovery-srv ‘‘
　　　　　　dns srv domain used to bootstrap the cluster.
　　　　--strict-reconfig-check
　　　　　　reject reconfiguration requests that would cause quorum loss.
　　　　--auto-compaction-retention ‘0‘
　　　　　　auto compaction retention in hour. 0 means disable auto compaction.

proxy flags:
　　　　"proxy" supports v2 API only.

　　　　--proxy ‘off‘
　　　　　　proxy mode setting (‘off‘, ‘readonly‘ or ‘on‘).
　　　　--proxy-failure-wait 5000
　　　　　　time (in milliseconds) an endpoint will be held in a failed state.
　　　　--proxy-refresh-interval 30000
　　　　　　time (in milliseconds) of the endpoints refresh interval.
　　　　--proxy-dial-timeout 1000
　　　　　　time (in milliseconds) for a dial to timeout.
　　　　--proxy-write-timeout 5000
　　　　　　time (in milliseconds) for a write to timeout.
　　　　--proxy-read-timeout 0
　　　　　　time (in milliseconds) for a read to timeout.

security flags:

　　　　--ca-file ‘‘ [DEPRECATED]
　　　　　　path to the client server TLS CA file. ‘-ca-file ca.crt‘ could be replaced by ‘-trusted-ca-file ca.crt -client-cert-auth‘ and etcd will perform the same.
　　　　--cert-file ‘‘
　　　　　　path to the client server TLS cert file.
　　　　--key-file ‘‘
　　　　　　path to the client server TLS key file.
　　　　--client-cert-auth ‘false‘
　　　　　　enable client cert authentication.
　　　　--trusted-ca-file ‘‘
　　　　　　path to the client server TLS trusted CA key file.
　　　　--auto-tls ‘false‘
　　　　　　client TLS using generated certificates.
　　　　--peer-ca-file ‘‘ [DEPRECATED]
　　　　　　path to the peer server TLS CA file. ‘-peer-ca-file ca.crt‘ could be replaced by ‘-peer-trusted-ca-file ca.crt -peer-client-cert-auth‘ and etcd will perform the same.
　　　　--peer-cert-file ‘‘
　　　　　　path to the peer server TLS cert file.
　　　　--peer-key-file ‘‘
　　　　　　path to the peer server TLS key file.
　　　　--peer-client-cert-auth ‘false‘
　　　　　　enable peer client cert authentication.
　　　　--peer-trusted-ca-file ‘‘
　　　　　　path to the peer server TLS trusted CA file.
　　　　--peer-auto-tls ‘false‘
　　　　　　peer TLS using self-generated certificates if --peer-key-file and --peer-cert-file are not provided.

logging flags

　　　　--debug ‘false‘
　　　　　　enable debug-level logging for etcd.
　　　　--log-package-levels ‘‘
　　　　　　specify a particular log level for each etcd package (eg: ‘etcdmain=CRITICAL,etcdserver=DEBUG‘).

unsafe flags:

　　　　Please be CAUTIOUS when using unsafe flags because it will break the guarantees
　　　　given by the consensus protocol.

　　　　--force-new-cluster ‘false‘
　　　　　　force to create a new one-member cluster.

profiling flags:
　　　　--enable-pprof ‘false‘
　　　　　　Enable runtime profiling data via HTTP server. Address is at client URL + "/debug/pprof"