etcd - Man Page
Name
etcd - Distributed reliable key-value store for the most critical data of a distributed system
Usage
etcd [flags]
Description
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.
General Options
Member flags
--data-dir
Path to the data directory.
--wal-dir
Path to the dedicated wal directory.
--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.
--listen-metrics-urls
List of URLs to listen on for the metrics and health endpoints.
--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).
--name default
Human-readable name for this member.
--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.
--initial-election-tick-advance true
Whether to fast-forward initial election ticks on boot for faster election.
--quota-backend-bytes 0
Raise alarms when backend size exceeds the given quota. 0 means use the default quota.
--backend-batch-interval 0s
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 interval duration that a client should wait before pinging server.
--grpc-keepalive-interval 2h0m0s
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 flags
--initial-advertise-peer-urls http://localhost:2380
List of this member's peer URLs to advertise to the rest of the cluster.
--advertise-client-urls http://localhost:2379
List of this member's client URLs to advertise to the public.
--discovery
Discovery URL used to bootstrap the cluster.
--discovery-fallback proxy
Valid values include ["exit" "proxy"]
--discovery-proxy
HTTP proxy to use for traffic to discovery service.
--discovery-srv
DNS domain used to bootstrap initial cluster.
--discovery-srv-name
Service name to query when using DNS discovery.
--initial-cluster default=http://localhost:2380
Initial cluster configuration for bootstrapping.
--initial-cluster-token etcd-cluster
Initial cluster token for the etcd cluster during bootstrap.
--initial-cluster-state new
Initial cluster state ('new' or 'existing').
--strict-reconfig-check true
Reject reconfiguration requests that would cause quorum loss.
--enable-v2 false
Accept etcd V2 client requests.
--pre-vote false
Enable to run an additional Raft election phase.
Proxy flags
--proxy off
Valid values include ["off" "on" "readonly"]
--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
--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-auto-tls false
Peer TLS using generated certificates
--peer-crl-file
Path to the peer certificate revocation list file.
--peer-cert-allowed-cn
Allowed CN for inter peer authentication.
--peer-cert-allowed-hostname
Allowed TLS hostname for inter peer authentication.
--cipher-suites
Comma-separated list of supported TLS cipher suites between client/server and peers (empty will be auto-populated by Go).
--experimental-peer-skip-client-san-verification false
Skip verification of SAN field in client certificate for peer connections.
--cors *
Comma-separated white list of origins for CORS, or cross-origin resource sharing, (empty or * means allow all)
--host-whitelist *
Comma-separated acceptable hostnames from HTTP client requests, if server is not secure (empty means allow all).
Logging flags
--logger capnslog
Specify 'zap' for structured logging or 'capnslog'. WARN: 'capnslog' is being deprecated in v3.5.
--log-output default
[TO BE DEPRECATED IN v3.5] use '--log-outputs'.
--log-outputs default
Specify 'stdout' or 'stderr' to skip journald logging even when running under systemd, or list of comma separated output targets.
--debug false
[TO BE DEPRECATED IN v3.5] Enable debug-level logging for etcd. Use '--log-level=debug' instead.
--log-level info
Configures log level. Only supports debug, info, warn, error, panic, or fatal. Default 'info'.
--log-package-levels
[TO BE DEPRECATED IN v3.5] Specify a particular log level for each etcd package (eg: 'etcdmain=CRITICAL,etcdserver=DEBUG').
Version flags
--version false
Print the version and exit.
--auto-compaction-retention 0
Auto compaction retention for mvcc key value store. 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.
Profiling flags
--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
Auth flags
--auth-token simple
Specify auth token specific options.
--bcrypt-cost 10
Specify bcrypt algorithm cost factor for auth password hashing.
--auth-token-ttl 300
The lifetime in seconds of the auth token.
Gateway flags
--enable-grpc-gateway true
Enable GRPC gateway.
Experimental flags
--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
v3 prefix for serving emulated v2 state.
--experimental-backend-bbolt-freelist-type
ExperimentalBackendFreelistType specifies the type of freelist that boltdb backend uses(array and map are supported types)
--experimental-enable-lease-checkpoint false
Enable to persist lease remaining TTL to prevent indefinite auto-renewal of long lived leases.
--experimental-compaction-batch-limit 0
Sets the maximum revisions deleted in each compaction batch.
--experimental-watch-progress-notify-interval 0s
Duration of periodic watch progress notifications.
Unsafe flags
--unsafe-no-fsync false
Disables fsync, unsafe, will cause data loss.
--force-new-cluster false
Force to create a new one member cluster.