ETCD(1)

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
    --cors
          Comma-separated white list of origins for CORS (cross-origin resource sharing).
    --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.
    --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.
    --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.
    --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 true
          Accept etcd V2 client requests.
Proxy flags
    --proxy off
          Valid values include off, readonly, 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.
    --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-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
    --cipher-suites
          Comma-separated list of supported TLS cipher suites between client/server and peers (empty will be auto-populated by Go).
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').
    --log-output default
          Specify 'stdout' or 'stderr' to skip journald logging even when running under systemd.
Unsafe flags
    --force-new-cluster false
          Force to create a new one member cluster.
Version flags
    --version false
          Print the version and exit.
    --auto-compaction-retention 0
          Auto compaction retention for mvcc key value store in hour. 0 means disable auto compaction.
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.

SEE ALSO:
etcdctl(1), etcdctl2(1), etcdctl3(1)