etcd参数详解

 etcd 可以通过命令行标记和环境变量来配置。命令行上设置的选项优先于环境变量。

对于标记 --my-flag 环境变量的格式是 ETCD_MY_FLAG。 适用于所有标记。

正式的ectd端口 是 2379 用于客户端连接，而 2380 用于伙伴通讯。etcd 端口可以设置为接受 TLS 通讯，non-TLS 通讯，或者同时有 TLS 和 non-TLS 通讯。

为了在 linux 启动试使用自定义设置自动启动 etcd ，强烈推荐使用 systemd单元。

成员标记

—name

• 成员的可读性的名字.
• 默认: “default”
• 环境变量: ETCD_NAME
• 这个值被作为这个节点自己的入口中被引用， 在 --initial-cluster 标记(例如, default=http://localhost:2380)中列出。如果使用 static bootstrapping,这需要匹配在标记中使用的key。当使用发现时，每个成员必须有唯一名字。Hostname 或 machine-id 可以是一个好选择。

—data-dir

• 到数据目录的路径.
• 默认: “${name}.etcd”
• 环境变量: ETCD_DATA_DIR

—wal-dir

• 到专用的 wal 目录的路径。如果这个标记被设置，etcd将写 WAL 文件到 walDIR 而不是 dataDIR。这容许使用专门的硬盘，并帮助避免日志和其他IO操作之间的IO竞争。
• 默认: “”
• 环境变量: ETCD_WAL_DIR

—snapshot-count

• 触发快照到硬盘的已提交事务的数量.
• 默认: “10000”
• 环境变量: ETCD_SNAPSHOT_COUNT

—heartbeat-interval

• 心跳间隔时间 (单位 毫秒).
• 默认: “100”
• 环境变量: ETCD_HEARTBEAT_INTERVAL

—election-timeout

• 选举的超时时间(单位 毫秒). 阅读 Documentation/tuning.md 得到更多详情.
• 默认: “1000”
• 环境变量: ETCD_ELECTION_TIMEOUT

—listen-peer-urls

用于监听伙伴通讯的URL列表。这个标记告诉 etcd 在特定的 scheme://IP:port 组合上从它的伙伴接收进来的请求。scheme 可是 http 或者 https。如果IP被指定为0.0.0.0,etcd 在所有接口上监听给定端口。如果给定IP地址和端口，etcd 将监听在给定端口和接口上。多个URL可以用来指定多个地址和端口来监听。etcd将从任何列出来的地址和端口上应答请求。

• 默认: “http://localhost:2380“
• 环境变量: ETCD_LISTEN_PEER_URLS
• 例子: “http://10.0.0.1:2380“
• 无效例子: “http://example.com:2380“ (对于绑定域名无效)

—listen-client-urls

用于监听客户端通讯的URL列表。这个标记告诉 etcd 在特定的 scheme://IP:port 组合上从客户端接收进来的请求。scheme 可是 http 或者 https。如果IP被指定为 0.0.0.0,etcd 在所有接口上监听给定端口。如果给定IP地址和端口，etcd 将监听在给定端口和接口上。多个 URL 可以用来指定多个地址和端口来监听。etcd 将从任何列出来的地址和端口上应答请求。

• 默认: “http://localhost:2379“
• 环境变量: ETCD_LISTEN_CLIENT_URLS
• 例子: “http://10.0.0.1:2379“
• 无效例子: “http://example.com:2379“ (对于绑定域名无效)

—max-snapshots

• 保持的快照文件的最大数量 (0 表示不限制)
• 默认: 5
• 环境变量: ETCD_MAX_SNAPSHOTS
• 对于 windows 用户默认不限制，而且推荐手工降低到5（或者某些安全偏好)。

—max-wals

• 保持的 wal 文件的最大数量 (0 表示不限制)
• 默认: 5
• 环境变量: ETCD_MAX_WALS
• 对于windows用户默认不限制，而且推荐手工降低到5（或者某些安全偏好)。

—cors

• 逗号分割的 origin 白名单，用于 CORS (cross-origin resource sharing/跨 origin 资源共享).
• 默认: none
• 环境变量: ETCD_CORS

集群标记

--initial 前缀标记用于启动(static bootstrap, [discovery-service bootstrap])(clustering.md#discovery) 或 runtime reconfiguration) 新成员, 然后当重新启动一个已有的成员时被忽略。

--discovery 前缀标记在使用发现服务需要设置.

—initial-advertise-peer-urls

列出这个成员的伙伴 URL 以便通告给集群的其他成员。这些地方用于在集群中通讯 etcd 数据。至少有一个必须对所有集群成员可以路由的。这些 URL 可以包含域名。

• 默认: “http://localhost:2380“
• 环境变量: ETCD_INITIAL_ADVERTISE_PEER_URLS
• 例子: “http://example.com:2380, http://10.0.0.1:2380“

—initial-cluster

为启动初始化集群配置。

• 默认: “default=http://localhost:2380“
• 环境变量: ETCD_INITIAL_CLUSTER
• key是每个提供的节点的 --name 标记的值. 默认为这个 key 使用 default 因为这是 --name 标记的默认值.

—initial-cluster-state

初始化集群状态(“new” or “existing”)。在初始化静态(initial static)或者 DNS 启动 (DNS bootstrapping) 期间为所有成员设置为 new 。如果这个选项被设置为 existing , etcd 将试图加入已有的集群。如果设置为错误的值，etcd 将尝试启动但安全失败。

• 默认: “new”
• 环境变量: ETCD_INITIAL_CLUSTER_STATE

—initial-cluster-token

在启动期间用于 etcd 集群的初始化集群记号(cluster token)。

• 默认: “etcd-cluster”
• 环境变量: ETCD_INITIAL_CLUSTER_TOKEN

—advertise-client-urls

列出这个成员的客户端URL，通告给集群中的其他成员。这些 URL 可以包含域名。

• 默认: “http://localhost:2379“
• 环境变量: ETCD_ADVERTISE_CLIENT_URLS
• 例子: “http://example.com:2379, http://10.0.0.1:2379“

小心，如果来自集群成员的通告 URL 比如 http://localhost:2379 正在使用 etcd 的 proxy 特性。这将导致循环，因为代理将转发请求给它自己直到它的资源(内存，文件描述符)最终耗尽。

—discovery

用于启动集群的发现URL。

• 默认: none
• 环境变量: ETCD_DISCOVERY

—discovery-srv

用于启动集群的 DNS srv 域名。

• 默认: none
• 环境变量: ETCD_DISCOVERY_SRV

—discovery-fallback

当发现服务失败时的期待行为(“exit” 或 “proxy”). “proxy” 仅支持 v2 API.

• 默认: “proxy”
• 环境变量: ETCD_DISCOVERY_FALLBACK

—discovery-proxy

用于请求到发现服务的 HTTP 代理。

• 默认: none
• 环境变量: ETCD_DISCOVERY_PROXY

—strict-reconfig-check

拒绝将导致法定人数丢失的重配置请求。

• 默认: false
• 环境变量: ETCD_STRICT_RECONFIG_CHECK

—auto-compaction-retention

自动压缩用于 mvcc 键值存储的保持力(注：应该指多版本保存)，单位小时。 0 表示关闭自动压缩。

• 默认: 0
• 环境变量: ETCD_AUTO_COMPACTION_RETENTION

注： 对于服务注册等只保存运行时动态信息的场合，建议开启。完全没有理由损失存储空间和效率来保存之前的版本信息。推荐设置为1,每小时压缩一次。

Proxy flags

--proxy 前缀标记配置 etcd 以 代理模式 运行. “proxy” 仅支持 v2 API.

—proxy

代理模式设置(“off”, “readonly” or “on”).

• 默认: “off”
• 环境变量: ETCD_PROXY

—proxy-failure-wait

在被重新考虑之前，终端将被视为失败状态的时间(单位 毫秒)，用于被代理的请求。

• 默认: 5000
• 环境变量: ETCD_PROXY_FAILURE_WAIT

—proxy-refresh-interval

终端刷新间隔时间(单位 毫秒)

• 默认: 30000
• 环境变量: ETCD_PROXY_REFRESH_INTERVAL

—proxy-dial-timeout

请求的拨号(dial)超时时间(单位 毫秒)，或者 0 禁用超时。

• 默认: 1000
• 环境变量 ETCD_PROXY_DIAL_TIMEOUT

—proxy-write-timeout

写操作的超时时间(单位 毫秒)，或者 0 禁用超时。

• 默认: 5000
• 环境变量: ETCD_PROXY_WRITE_TIMEOUT

—proxy-read-timeout

读操作的超时时间(单位 毫秒)，或者 0 禁用超时。

不要修改这个值，如果在使用 watch，因为 watch 将使用 long polling 请求。

• 默认: 0
• 环境变量: ETCD_PROXY_READ_TIMEOUT

安全标记

安全标记用于帮助 搭建安全 etcd 集群.

—ca-file [弃用]

客户端服务器 TLS 证书文件的路径。--ca-file ca.crt 可以被 --trusted-ca-file ca.crt --client-cert-auth 替代，而 etcd 同样工作。

• 默认: none
• 环境变量: ETCD_CA_FILE

—cert-file

客户端服务器 TLS 证书文件的路径。

• 默认: none
• 环境变量: ETCD_CERT_FILE

—key-file

客户端服务器 TLS key 文件的路径。

• 默认: none
• 环境变量: ETCD_KEY_FILE

—client-cert-auth

开启客户端证书认证。

• 默认: false
• 环境变量: ETCD_CLIENT_CERT_AUTH

—trusted-ca-file

客户端服务器 TLS 信任证书文件的路径。

• 默认: none
• 环境变量: ETCD_TRUSTED_CA_FILE

—auto-tls

使用生成证书的客户端 TLS。

• 默认: false
• 环境变量: ETCD_AUTO_TLS

—peer-ca-file [弃用]

peer server TLS 证书文件的路径. --peer-ca-file ca.crt 可以被 --peer-trusted-ca-file ca.crt --peer-client-cert-auth 替代，而 etcd 同样工作.

• 默认: none
• 环境变量: ETCD_PEER_CA_FILE

—peer-cert-file

peer server TLS 证书文件的路径.

• 默认: none
• 环境变量: ETCD_PEER_CERT_FILE

—peer-key-file

peer server TLS key 文件的路径.

• 默认: none
• 环境变量: ETCD_PEER_KEY_FILE

—peer-client-cert-auth

开启 peer client 证书验证.

• 默认: false
• 环境变量: ETCD_PEER_CLIENT_CERT_AUTH

—peer-trusted-ca-file

peer server TLS 信任证书文件路径.

• 默认: none
• 环境变量: ETCD_PEER_TRUSTED_CA_FILE

—peer-auto-tls

使用生成证书的peer TLS。

• 默认: false
• 环境变量: ETCD_PEER_AUTO_TLS

日志标记

—debug

设置所有子包的默认日志级别为 DEBUG

• 默认: false (所有包为 INFO)
• 环境变量: ETCD_DEBUG

—log-package-levels

设置个人 etcd 子包为指定日志级别。例如 etcdserver=WARNING,security=DEBUG

• 默认: none (所有包为 INFO)
• 环境变量: ETCD_LOG_PACKAGE_LEVELS

不安全的标记

请谨慎使用不安全标记，因为它将打破一致性协议提供的保证。

例如，它可能惊慌，如果集群中的其他成员还活着。

当使用这些标记时，遵循操作指南。

—force-new-cluster

强制创建新的单一成员的集群。它提交配置修改来强制移除集群中的所有现有成员然后添加自身。当 restore a backup 时需要设置。

• 默认: false
• 环境变量: ETCD_FORCE_NEW_CLUSTER

其他标记

—version

打印版本并退出.

• 默认: false

—config-file

从文件中装载服务器配置.

• 默认: none

分析标记

—enable-pprof

通过 HTTP 服务器开启运行时分析数据。地址是 client URL + “/debug/pprof/“

• 默认: false

—metrics

• 为导出的度量，设置详情的等级，指定 ‘extensive’ 来包含柱状图
• 默认: basic

[root@hdss7-12 system]# /opt/etcd/etcd --version
etcd Version: 3.4.14
Git SHA: 8a03d2e96
Go Version: go1.12.17
Go OS/Arch: linux/amd64


Usage:

  etcd [flags]
    Start an etcd server.

  etcd --version   #查看etcd版本
    Show the version of etcd.

  etcd -h | --help   #获取帮助信息
    Show the help information about etcd.

  etcd --config-file   #从文件加载配置信息。
    Path to the server configuration file. Note that if a configuration file is provided, other command line flags and environment variables will be ignored.

  etcd gateway
    Run the stateless pass-through etcd TCP connection forwarding proxy.

  etcd grpc-proxy
    Run the stateless etcd v3 gRPC L7 reverse proxy.


Member:
  --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 '100000'
    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.
  --initial-election-tick-advance 'true'
    Whether to fast-forward initial election ticks on boot for faster election.
  --listen-peer-urls 'http://localhost:2380'
    List of URLs to listen on for peer traffic.
  --listen-client-urls 'http://localhost:2379'
    List of URLs to listen on for client traffic.
  --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).
  --quota-backend-bytes '0'
    Raise alarms when backend size exceeds the given quota (0 defaults to low space quota).
  --backend-batch-interval ''
    BackendBatchInterval is the maximum time before commit the backend transaction.
  --backend-batch-limit '0'
    BackendBatchLimit is the maximum operations before commit the backend transaction.
  --max-txn-ops '128'
    Maximum number of operations permitted in a transaction.
  --max-request-bytes '1572864'
    Maximum client request size in bytes the server will accept.
  --grpc-keepalive-min-time '5s'
    Minimum duration interval that a client should wait before pinging server.
  --grpc-keepalive-interval '2h'
    Frequency duration of server-to-client ping to check if a connection is alive (0 to disable).
  --grpc-keepalive-timeout '20s'
    Additional duration of wait before closing a non-responsive connection (0 to disable).

Clustering:
  --initial-advertise-peer-urls 'http://localhost:2380'
    List of this member's peer URLs to advertise to the rest of the cluster.
  --initial-cluster 'default=http://localhost:2380'
    Initial cluster configuration for bootstrapping.
  --initial-cluster-state 'new'
    Initial cluster state ('new' or 'existing').
  --initial-cluster-token 'etcd-cluster'
    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'
    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.
  --discovery-srv-name ''
    Suffix to the dns srv name queried when bootstrapping.
  --strict-reconfig-check 'true'
    Reject reconfiguration requests that would cause quorum loss.
  --pre-vote 'false'
    Enable to run an additional Raft election phase.
  --auto-compaction-retention '0'
    Auto compaction retention length. 0 means disable auto compaction.
  --auto-compaction-mode 'periodic'
    Interpret 'auto-compaction-retention' one of: periodic|revision. 'periodic' for duration based retention, defaulting to hours if no time unit is provided (e.g. '5m'). 'revision' for revision number based retention.
  --enable-v2 'false'
    Accept etcd V2 client requests.

Security:
  --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.
  --client-crl-file ''
    Path to the client certificate revocation list file.
  --client-cert-allowed-hostname ''
    Allowed TLS hostname for client cert authentication.
  --trusted-ca-file ''
    Path to the client server TLS trusted CA cert file.
  --auto-tls 'false'
    Client TLS using generated certificates.
  --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-cert-allowed-cn ''
    Required CN for client certs connecting to the peer endpoint.
  --peer-cert-allowed-hostname ''
    Allowed TLS hostname for inter peer authentication.
  --peer-auto-tls 'false'
    Peer TLS using self-generated certificates if --peer-key-file and --peer-cert-file are not provided.
  --peer-crl-file ''
    Path to the peer certificate revocation list file.
  --cipher-suites ''
    Comma-separated list of supported TLS cipher suites between client/server and peers (empty will be auto-populated by Go).
  --cors '*'
    Comma-separated whitelist of origins for CORS, or cross-origin resource sharing, (empty or * means allow all).
  --host-whitelist '*'
    Acceptable hostnames from HTTP client requests, if server is not secure (empty or * means allow all).

Auth:
  --auth-token 'simple'
    Specify a v3 authentication token type and its options ('simple' or 'jwt').
  --bcrypt-cost 10
    Specify the cost / strength of the bcrypt algorithm for hashing auth passwords. Valid values are between 4 and 31.
  --auth-token-ttl 300
    Time (in seconds) of the auth-token-ttl.

Profiling and Monitoring:
  --enable-pprof 'false'
    Enable runtime profiling data via HTTP server. Address is at client URL + "/debug/pprof/"
  --metrics 'basic'
    Set level of detail for exported metrics, specify 'extensive' to include histogram metrics.
  --listen-metrics-urls ''
    List of URLs to listen on for the metrics and health endpoints.

Logging:
  --logger 'capnslog'
    Specify 'zap' for structured logging or 'capnslog'. [WARN] 'capnslog' will be deprecated in v3.5.
  --log-outputs 'default'
    Specify 'stdout' or 'stderr' to skip journald logging even when running under systemd, or list of comma separated output targets.
  --log-level 'info'
    Configures log level. Only supports debug, info, warn, error, panic, or fatal.

v2 Proxy (to be deprecated in v4):
  --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.

Experimental feature:
  --experimental-initial-corrupt-check 'false'
    Enable to check data corruption before serving any client/peer traffic.
  --experimental-corrupt-check-time '0s'
    Duration of time between cluster corruption check passes.
  --experimental-enable-v2v3 ''
    Serve v2 requests through the v3 backend under a given prefix.
  --experimental-backend-bbolt-freelist-type 'array'
    ExperimentalBackendFreelistType specifies the type of freelist that boltdb backend uses(array and map are supported types).
  --experimental-enable-lease-checkpoint 'false'
    ExperimentalEnableLeaseCheckpoint enables primary lessor to persist lease remainingTTL to prevent indefinite auto-renewal of long lived leases.
  --experimental-compaction-batch-limit 1000
    ExperimentalCompactionBatchLimit sets the maximum revisions deleted in each compaction batch.
  --experimental-peer-skip-client-san-verification 'false'
    Skip verification of SAN field in client certificate for peer connections.
  --experimental-watch-progress-notify-interval '10m'
    Duration of periodical watch progress notification.

Unsafe feature:
  --force-new-cluster 'false'
    Force to create a new one-member cluster.

CAUTIOUS with unsafe flag! It may break the guarantees given by the consensus protocol!

TO BE DEPRECATED:

  --debug 'false'
    Enable debug-level logging for etcd. [WARN] Will be deprecated in v3.5. Use '--log-level=debug' instead.
  --log-package-levels ''
    Specify a particular log level for each etcd package (eg: 'etcdmain=CRITICAL,etcdserver=DEBUG').

参考文档  https://www.bookstack.cn/read/etcd/README.md