etcd man page
etcd - Distributed reliable key-value store for the most critical data of a distributed system
Etcd is a distributed key-value store designed to reliably and quickly preserve and provide access to critical data. It enables reliable distributed coordination through distributed locking, leader elections, and write barriers. An etcd cluster is intended for high availability and permanent data storage and retrieval.
Path to the data directory.
Path to the dedicated wal directory.
List of URLs to listen on for peer traffic.
List of URLs to listen on for client traffic.
List of URLs to listen on for the metrics and health endpoints.
Maximum number of snapshot files to retain (0 is unlimited).
Maximum number of wal files to retain (0 is unlimited).
Human-readable name for this member.
Number of committed transactions to trigger a snapshot to disk.
Time (in milliseconds) of a heartbeat interval.
Time (in milliseconds) for an election to timeout.
Whether to fast-forward initial election ticks on boot for faster election.
Raise alarms when backend size exceeds the given quota. 0 means use the default quota.
BackendBatchInterval is the maximum time before commit the backend transaction.
BackendBatchLimit is the maximum operations before commit the backend transaction.
Maximum number of operations permitted in a transaction.
Maximum client request size in bytes the server will accept.
Minimum interval duration that a client should wait before pinging server.
Frequency duration of server-to-client ping to check if a connection is alive (0 to disable).
Additional duration of wait before closing a non-responsive connection (0 to disable).
List of this member's peer URLs to advertise to the rest of the cluster.
List of this member's client URLs to advertise to the public.
Discovery URL used to bootstrap the cluster.
Valid values include ["exit" "proxy"]
HTTP proxy to use for traffic to discovery service.
DNS domain used to bootstrap initial cluster.
Service name to query when using DNS discovery.
Initial cluster configuration for bootstrapping.
Initial cluster token for the etcd cluster during bootstrap.
Initial cluster state ('new' or 'existing').
Reject reconfiguration requests that would cause quorum loss.
Accept etcd V2 client requests.
Enable to run an additional Raft election phase.
Valid values include ["off" "on" "readonly"]
Time (in milliseconds) an endpoint will be held in a failed state.
Time (in milliseconds) of the endpoints refresh interval.
Time (in milliseconds) for a dial to timeout.
Time (in milliseconds) for a write to timeout.
Time (in milliseconds) for a read to timeout.
Path to the client server TLS cert file.
Path to the client server TLS key file.
Enable client cert authentication.
Path to the client certificate revocation list file.
Path to the client server TLS trusted CA cert file.
Client TLS using generated certificates
Path to the peer server TLS cert file.
Path to the peer server TLS key file.
Enable peer client cert authentication.
Path to the peer server TLS trusted CA file.
Peer TLS using generated certificates
Path to the peer certificate revocation list file.
Allowed CN for inter peer authentication.
Comma-separated list of supported TLS cipher suites between client/server and peers (empty will be auto-populated by Go).
Comma-separated white list of origins for CORS, or cross-origin resource sharing, (empty or * means allow all)
Comma-separated acceptable hostnames from HTTP client requests, if server is not secure (empty means allow all).
Specify 'zap' for structured logging or 'capnslog'.
DEPRECATED: use '--log-outputs'.
Specify 'stdout' or 'stderr' to skip journald logging even when running under systemd, or list of comma separated output targets.
Enable debug-level logging for etcd.
(To be deprecated) Specify a particular log level for each etcd package (eg: 'etcdmain=CRITICAL,etcdserver=DEBUG').
Print the version and exit.
Auto compaction retention for mvcc key value store. 0 means disable auto compaction.
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 runtime profiling data via HTTP server. Address is at client URL + "/debug/pprof/"
Set level of detail for exported metrics, specify 'extensive' to include histogram metrics
Specify auth token specific options.
Specify bcrypt algorithm cost factor for auth password hashing.
Enable GRPC gateway.
Enable to check data corruption before serving any client/peer traffic.
Duration of time between cluster corruption check passes.
v3 prefix for serving emulated v2 state.
ExperimentalBackendFreelistType specifies the type of freelist that boltdb backend uses(array and map are supported types)
Force to create a new one member cluster.
etcdctl(1), etcdctl2(1), etcdctl3(1)