2016-06-27 21:59:59 +03:00
# Configuration flags
2014-11-25 03:22:25 +03:00
2017-12-24 20:03:13 +03:00
etcd is configurable through a configuration file, various command-line flags, and environment variables.
A reusable configuration file is a YAML file made with name and value of one or more command-line flags described below. In order to use this file, specify the file path as a value to the `--config-file` flag. The [sample configuration file][sample-config-file] can be used as a starting point to create a new configuration file as needed.
Options set on the command line take precedence over those from the environment. If a configuration file is provided, other command line flags and environment variables will be ignored.
For example, `etcd --config-file etcd.conf.yml.sample --data-dir /tmp` will ignore the `--data-dir` flag.
2014-11-25 03:22:25 +03:00
2016-05-11 20:42:36 +03:00
The format of environment variable for flag `--my-flag` is `ETCD_MY_FLAG` . It applies to all flags.
2014-11-25 03:22:25 +03:00
2016-05-11 20:42:36 +03:00
The [official etcd ports][iana-ports] are 2379 for client requests and 2380 for peer communication. The etcd ports can be set to accept TLS traffic, non-TLS traffic, or both TLS and non-TLS traffic.
2015-12-29 01:43:00 +03:00
2014-11-25 03:22:25 +03:00
To start etcd automatically using custom settings at startup in Linux, using a [systemd][systemd-intro] unit is highly recommended.
2016-06-27 21:59:59 +03:00
## Member flags
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --name
2014-11-25 03:22:25 +03:00
+ Human-readable name for this member.
+ default: "default"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_NAME
2016-06-24 03:25:38 +03:00
+ This value is referenced as this node's own entries listed in the `--initial-cluster` flag (e.g., `default=http://localhost:2380` ). This needs to match the key used in the flag if using [static bootstrapping][build-cluster]. When using discovery, each member must have a unique name. `Hostname` or `machine-id` can be a good choice.
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --data-dir
2014-11-25 03:22:25 +03:00
+ Path to the data directory.
+ default: "${name}.etcd"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_DATA_DIR
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --wal-dir
2015-09-01 01:01:18 +03:00
+ Path to the dedicated wal directory. If this flag is set, etcd will write the WAL files to the walDir rather than the dataDir. This allows a dedicated disk to be used, and helps avoid io competition between logging and other IO operations.
+ default: ""
+ env variable: ETCD_WAL_DIR
2016-02-24 19:27:01 +03:00
### --snapshot-count
2014-11-25 03:22:25 +03:00
+ Number of committed transactions to trigger a snapshot to disk.
2017-01-14 05:00:28 +03:00
+ default: "100000"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_SNAPSHOT_COUNT
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --heartbeat-interval
2015-01-15 22:11:33 +03:00
+ Time (in milliseconds) of a heartbeat interval.
+ default: "100"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_HEARTBEAT_INTERVAL
2015-01-15 22:11:33 +03:00
2016-02-24 19:27:01 +03:00
### --election-timeout
2016-06-03 15:43:17 +03:00
+ Time (in milliseconds) for an election to timeout. See [Documentation/tuning.md][tuning] for details.
2015-01-15 22:11:33 +03:00
+ default: "1000"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_ELECTION_TIMEOUT
2015-01-15 22:11:33 +03:00
2016-02-24 19:27:01 +03:00
### --listen-peer-urls
2015-08-25 21:32:46 +03:00
+ List of URLs to listen on for peer traffic. This flag tells the etcd to accept incoming requests from its peers on the specified scheme://IP:port combinations. Scheme can be either http or https.If 0.0.0.0 is specified as the IP, etcd listens to the given port on all interfaces. If an IP address is given as well as a port, etcd will listen on the given port and interface. Multiple URLs may be used to specify a number of addresses and ports to listen on. The etcd will respond to requests from any of the listed addresses and ports.
2016-05-11 20:42:36 +03:00
+ default: "http://localhost:2380"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_LISTEN_PEER_URLS
2015-08-25 21:32:46 +03:00
+ example: "http://10.0.0.1:2380"
+ invalid example: "http://example.com:2380" (domain name is invalid for binding)
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --listen-client-urls
2015-08-25 21:32:46 +03:00
+ List of URLs to listen on for client traffic. This flag tells the etcd to accept incoming requests from the clients on the specified scheme://IP:port combinations. Scheme can be either http or https. If 0.0.0.0 is specified as the IP, etcd listens to the given port on all interfaces. If an IP address is given as well as a port, etcd will listen on the given port and interface. Multiple URLs may be used to specify a number of addresses and ports to listen on. The etcd will respond to requests from any of the listed addresses and ports.
2016-05-11 20:42:36 +03:00
+ default: "http://localhost:2379"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_LISTEN_CLIENT_URLS
2015-08-25 21:32:46 +03:00
+ example: "http://10.0.0.1:2379"
+ invalid example: "http://example.com:2379" (domain name is invalid for binding)
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --max-snapshots
2014-12-13 03:08:57 +03:00
+ Maximum number of snapshot files to retain (0 is unlimited)
+ default: 5
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_MAX_SNAPSHOTS
2016-06-24 03:25:38 +03:00
+ The default for users on Windows is unlimited, and manual purging down to 5 (or some preference for safety) is recommended.
2014-12-13 03:08:57 +03:00
2016-02-24 19:27:01 +03:00
### --max-wals
2014-12-13 03:08:57 +03:00
+ Maximum number of wal files to retain (0 is unlimited)
+ default: 5
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_MAX_WALS
2016-06-24 03:25:38 +03:00
+ The default for users on Windows is unlimited, and manual purging down to 5 (or some preference for safety) is recommended.
2014-12-13 03:08:57 +03:00
2016-02-24 19:27:01 +03:00
### --cors
2014-11-25 03:22:25 +03:00
+ Comma-separated white list of origins for CORS (cross-origin resource sharing).
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_CORS
2014-11-25 03:22:25 +03:00
2017-10-02 19:46:26 +03:00
### --quota-backend-bytes
+ Raise alarms when backend size exceeds the given quota (0 defaults to low space quota).
+ default: 0
+ env variable: ETCD_QUOTA_BACKEND_BYTES
### --max-txn-ops
+ Maximum number of operations permitted in a transaction.
+ default: 128
+ env variable: ETCD_MAX_TXN_OPS
### --max-request-bytes
+ Maximum client request size in bytes the server will accept.
+ default: 1572864
+ env variable: ETCD_MAX_REQUEST_BYTES
### --grpc-keepalive-min-time
+ Minimum duration interval that a client should wait before pinging server.
+ default: 5s
+ env variable: ETCD_GRPC_KEEPALIVE_MIN_TIME
### --grpc-keepalive-interval
+ Frequency duration of server-to-client ping to check if a connection is alive (0 to disable).
+ default: 2h
+ env variable: ETCD_GRPC_KEEPALIVE_INTERVAL
### --grpc-keepalive-timeout
+ Additional duration of wait before closing a non-responsive connection (0 to disable).
+ default: 20s
+ env variable: ETCD_GRPC_KEEPALIVE_TIMEOUT
2016-06-27 21:59:59 +03:00
## Clustering flags
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
`--initial` prefix flags are used in bootstrapping ([static bootstrap][build-cluster], [discovery-service bootstrap][discovery] or [runtime reconfiguration][reconfig]) a new member, and ignored when restarting an existing member.
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
`--discovery` prefix flags need to be set when using [discovery service][discovery].
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --initial-advertise-peer-urls
2014-11-25 03:22:25 +03:00
2015-08-25 21:32:46 +03:00
+ List of this member's peer URLs to advertise to the rest of the cluster. These addresses are used for communicating etcd data around the cluster. At least one must be routable to all cluster members. These URLs can contain domain names.
2016-05-11 20:42:36 +03:00
+ default: "http://localhost:2380"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_INITIAL_ADVERTISE_PEER_URLS
2015-08-25 21:32:46 +03:00
+ example: "http://example.com:2380, http://10.0.0.1:2380"
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --initial-cluster
2014-11-25 03:22:25 +03:00
+ Initial cluster configuration for bootstrapping.
2016-05-11 20:42:36 +03:00
+ default: "default=http://localhost:2380"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_INITIAL_CLUSTER
2016-02-24 19:27:01 +03:00
+ The key is the value of the `--name` flag for each node provided. The default uses `default` for the key because this is the default for the `--name` flag.
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --initial-cluster-state
2015-01-30 01:54:52 +03:00
+ Initial cluster state ("new" or "existing"). Set to `new` for all members present during initial static or DNS bootstrapping. If this option is set to `existing` , etcd will attempt to join the existing cluster. If the wrong value is set, etcd will attempt to start but fail safely.
2014-11-25 03:22:25 +03:00
+ default: "new"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_INITIAL_CLUSTER_STATE
2014-11-25 03:22:25 +03:00
2015-01-30 01:54:52 +03:00
[static bootstrap]: clustering.md#static
2016-02-24 19:27:01 +03:00
### --initial-cluster-token
2014-11-25 03:22:25 +03:00
+ Initial cluster token for the etcd cluster during bootstrap.
+ default: "etcd-cluster"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_INITIAL_CLUSTER_TOKEN
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --advertise-client-urls
2015-08-25 21:32:46 +03:00
+ List of this member's client URLs to advertise to the rest of the cluster. These URLs can contain domain names.
2016-05-11 20:42:36 +03:00
+ default: "http://localhost:2379"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_ADVERTISE_CLIENT_URLS
2015-08-25 21:32:46 +03:00
+ example: "http://example.com:2379, http://10.0.0.1:2379"
2016-06-24 03:25:38 +03:00
+ Be careful if advertising URLs such as http://localhost:2379 from a cluster member and are using the proxy feature of etcd. This will cause loops, because the proxy will be forwarding requests to itself until its resources (memory, file descriptors) are eventually depleted.
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --discovery
2014-11-25 03:22:25 +03:00
+ Discovery URL used to bootstrap the cluster.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_DISCOVERY
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --discovery-srv
2014-12-22 23:10:04 +03:00
+ DNS srv domain used to bootstrap the cluster.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_DISCOVERY_SRV
2014-12-22 23:10:04 +03:00
2018-01-25 01:30:23 +03:00
### --discovery-srv-name
+ Suffix to the DNS srv name queried when bootstrapping using DNS.
+ default: ""
+ env variable: ETCD_DISCOVERY_SRV_NAME
2016-02-24 19:27:01 +03:00
### --discovery-fallback
2016-06-23 21:10:22 +03:00
+ Expected behavior ("exit" or "proxy") when discovery services fails. "proxy" supports v2 API only.
2014-11-25 03:22:25 +03:00
+ default: "proxy"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_DISCOVERY_FALLBACK
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --discovery-proxy
2014-11-25 03:22:25 +03:00
+ HTTP proxy to use for traffic to discovery service.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_DISCOVERY_PROXY
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --strict-reconfig-check
2015-09-18 08:05:57 +03:00
+ Reject reconfiguration requests that would cause quorum loss.
+ default: false
+ env variable: ETCD_STRICT_RECONFIG_CHECK
2016-06-17 20:04:31 +03:00
### --auto-compaction-retention
+ Auto compaction retention for mvcc key value store in hour. 0 means disable auto compaction.
+ default: 0
+ env variable: ETCD_AUTO_COMPACTION_RETENTION
2017-10-02 19:46:26 +03:00
### --auto-compaction-mode
2018-03-31 06:12:25 +03:00
+ 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.
2017-10-02 19:46:26 +03:00
+ default: periodic
+ env variable: ETCD_AUTO_COMPACTION_MODE
2017-01-16 19:55:26 +03:00
### --enable-v2
+ Accept etcd V2 client requests
+ default: true
+ env variable: ETCD_ENABLE_V2
2016-06-27 21:59:59 +03:00
## Proxy flags
2014-11-25 03:22:25 +03:00
2016-06-23 21:10:22 +03:00
`--proxy` prefix flags configures etcd to run in [proxy mode][proxy]. "proxy" supports v2 API only.
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --proxy
2014-11-25 03:22:25 +03:00
+ Proxy mode setting ("off", "readonly" or "on").
+ default: "off"
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PROXY
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --proxy-failure-wait
2015-06-16 13:18:16 +03:00
+ Time (in milliseconds) an endpoint will be held in a failed state before being reconsidered for proxied requests.
2015-06-12 21:35:38 +03:00
+ default: 5000
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PROXY_FAILURE_WAIT
2015-06-12 21:35:38 +03:00
2016-02-24 19:27:01 +03:00
### --proxy-refresh-interval
2015-06-12 21:35:38 +03:00
+ Time (in milliseconds) of the endpoints refresh interval.
+ default: 30000
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PROXY_REFRESH_INTERVAL
2015-06-12 21:35:38 +03:00
2016-02-24 19:27:01 +03:00
### --proxy-dial-timeout
2015-06-16 13:18:16 +03:00
+ Time (in milliseconds) for a dial to timeout or 0 to disable the timeout
2015-06-12 21:35:38 +03:00
+ default: 1000
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PROXY_DIAL_TIMEOUT
2015-06-12 21:35:38 +03:00
2016-02-24 19:27:01 +03:00
### --proxy-write-timeout
2015-06-16 13:18:16 +03:00
+ Time (in milliseconds) for a write to timeout or 0 to disable the timeout.
2015-06-12 21:35:38 +03:00
+ default: 5000
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PROXY_WRITE_TIMEOUT
2015-06-12 21:35:38 +03:00
2016-02-24 19:27:01 +03:00
### --proxy-read-timeout
2015-06-16 13:18:16 +03:00
+ Time (in milliseconds) for a read to timeout or 0 to disable the timeout.
2016-06-24 03:25:38 +03:00
+ Don't change this value if using watches because use long polling requests.
2015-06-12 21:35:38 +03:00
+ default: 0
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PROXY_READ_TIMEOUT
2015-06-12 21:35:38 +03:00
2016-06-27 21:59:59 +03:00
## Security flags
2014-11-25 03:22:25 +03:00
The security flags help to [build a secure etcd cluster][security].
2017-10-02 19:46:26 +03:00
### --ca-file
2017-05-04 03:07:47 +03:00
**DEPRECATED**
2016-02-24 19:27:01 +03:00
+ 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.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_CA_FILE
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --cert-file
2014-11-25 03:22:25 +03:00
+ Path to the client server TLS cert file.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_CERT_FILE
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --key-file
2014-11-25 03:22:25 +03:00
+ Path to the client server TLS key file.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_KEY_FILE
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --client-cert-auth
2015-04-07 01:26:41 +03:00
+ Enable client cert authentication.
+ default: false
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_CLIENT_CERT_AUTH
2015-04-07 01:26:41 +03:00
2017-10-02 19:46:26 +03:00
### --client-crl-file
+ Path to the client certificate revocation list file.
+ default: ""
+ env variable: ETCD_CLIENT_CRL_FILE
2016-02-24 19:27:01 +03:00
### --trusted-ca-file
2017-11-17 10:39:09 +03:00
+ Path to the client server TLS trusted CA cert file.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_TRUSTED_CA_FILE
2015-04-07 01:26:41 +03:00
2016-05-03 02:17:49 +03:00
### --auto-tls
+ Client TLS using generated certificates
+ default: false
+ env variable: ETCD_AUTO_TLS
2017-10-02 19:46:26 +03:00
### --peer-ca-file
2017-05-04 03:07:47 +03:00
**DEPRECATED**
2016-02-24 19:27:01 +03:00
+ 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.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PEER_CA_FILE
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --peer-cert-file
2018-01-19 03:15:48 +03:00
+ Path to the peer server TLS cert file. This is the cert for peer-to-peer traffic, used both for server and client.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PEER_CERT_FILE
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --peer-key-file
2018-01-19 03:15:48 +03:00
+ Path to the peer server TLS key file. This is the key for peer-to-peer traffic, used both for server and client.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PEER_KEY_FILE
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --peer-client-cert-auth
2015-04-07 01:26:41 +03:00
+ Enable peer client cert authentication.
+ default: false
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PEER_CLIENT_CERT_AUTH
2015-04-07 01:26:41 +03:00
2017-10-02 19:46:26 +03:00
### --peer-crl-file
+ Path to the peer certificate revocation list file.
+ default: ""
+ env variable: ETCD_PEER_CRL_FILE
2016-02-24 19:27:01 +03:00
### --peer-trusted-ca-file
2015-04-07 01:26:41 +03:00
+ Path to the peer server TLS trusted CA file.
2017-10-02 19:46:26 +03:00
+ default: ""
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_PEER_TRUSTED_CA_FILE
2015-04-07 01:26:41 +03:00
2016-05-03 02:17:49 +03:00
### --peer-auto-tls
+ Peer TLS using generated certificates
+ default: false
+ env variable: ETCD_PEER_AUTO_TLS
2017-09-22 12:22:09 +03:00
### --peer-cert-allowed-cn
+ Allowed CommonName for inter peer authentication.
+ default: none
+ env variable: ETCD_PEER_CERT_ALLOWED_CN
2016-06-27 21:59:59 +03:00
## Logging flags
2015-04-28 23:29:58 +03:00
2016-02-24 19:27:01 +03:00
### --debug
2015-04-28 23:29:58 +03:00
+ Drop the default log level to DEBUG for all subpackages.
+ default: false (INFO for all packages)
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_DEBUG
2015-04-28 23:29:58 +03:00
2016-02-24 19:27:01 +03:00
### --log-package-levels
2016-12-17 04:04:20 +03:00
+ Set individual etcd subpackages to specific log levels. An example being `etcdserver=WARNING,security=DEBUG`
2017-10-02 19:46:26 +03:00
+ default: "" (INFO for all packages)
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_LOG_PACKAGE_LEVELS
2015-04-28 23:29:58 +03:00
2016-06-27 21:59:59 +03:00
## Unsafe flags
2014-11-25 03:22:25 +03:00
2015-03-19 02:39:45 +03:00
Please be CAUTIOUS when using unsafe flags because it will break the guarantees given by the consensus protocol.
For example, it may panic if other members in the cluster are still alive.
Follow the instructions when using these flags.
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --force-new-cluster
2015-10-09 17:27:03 +03:00
+ Force to create a new one-member cluster. It commits configuration changes forcing to remove all existing members in the cluster and add itself. It needs to be set to [restore a backup][restore].
2014-11-25 03:22:25 +03:00
+ default: false
2015-08-26 00:35:15 +03:00
+ env variable: ETCD_FORCE_NEW_CLUSTER
2014-11-25 03:22:25 +03:00
2016-06-27 21:59:59 +03:00
## Miscellaneous flags
2014-11-25 03:22:25 +03:00
2016-02-24 19:27:01 +03:00
### --version
2014-11-25 03:22:25 +03:00
+ Print the version and exit.
+ default: false
2016-05-10 17:50:37 +03:00
### --config-file
+ Load server configuration from a file.
2017-10-02 19:46:26 +03:00
+ default: ""
2017-12-24 20:03:13 +03:00
+ example: [sample configuration file][sample-config-file]
2016-05-10 17:50:37 +03:00
2016-01-07 10:15:27 +03:00
## Profiling flags
2016-02-24 19:27:01 +03:00
### --enable-pprof
2016-07-07 12:35:07 +03:00
+ Enable runtime profiling data via HTTP server. Address is at client URL + "/debug/pprof/"
2016-01-07 10:15:27 +03:00
+ default: false
2016-12-17 04:04:20 +03:00
### --metrics
+ Set level of detail for exported metrics, specify 'extensive' to include histogram metrics.
+ default: basic
2017-10-02 19:46:26 +03:00
### --listen-metrics-urls
+ List of URLs to listen on for metrics.
+ default: ""
2016-07-21 08:13:57 +03:00
## Auth flags
### --auth-token
2017-07-25 10:22:30 +03:00
+ Specify a token type and token specific options, especially for JWT. Its format is "type,var1=val1,var2=val2,...". Possible type is 'simple' or 'jwt'. Possible variables are 'sign-method' for specifying a sign method of jwt (its possible values are 'ES256', 'ES384', 'ES512', 'HS256', 'HS384', 'HS512', 'RS256', 'RS384', 'RS512', 'PS256', 'PS384', or 'PS512'), 'pub-key' for specifying a path to a public key for verifying jwt, 'priv-key' for specifying a path to a private key for signing jwt, and 'ttl' for specifying TTL of jwt tokens.
+ Example option of JWT: '--auth-token jwt,pub-key=app.rsa.pub,priv-key=app.rsa,sign-method=RS512,ttl=10m'
2016-07-21 08:13:57 +03:00
+ default: "simple"
2017-10-03 02:35:26 +03:00
## Experimental flags
2017-10-02 19:46:26 +03:00
### --experimental-corrupt-check-time
+ Duration of time between cluster corruption check passes
+ default: 0s
2015-04-22 21:47:52 +03:00
[build-cluster]: clustering.md#static
[reconfig]: runtime-configuration.md
[discovery]: clustering.md#discovery
2017-05-03 20:00:01 +03:00
[iana-ports]: http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt
2016-04-27 21:34:07 +03:00
[proxy]: ../v2/proxy.md
2016-04-27 23:40:39 +03:00
[restore]: ../v2/admin_guide.md#restoring-a-backup
2016-02-04 20:36:02 +03:00
[security]: security.md
[systemd-intro]: http://freedesktop.org/wiki/Software/systemd/
2016-06-03 15:43:17 +03:00
[tuning]: ../tuning.md#time-parameters
2017-12-24 20:03:13 +03:00
[sample-config-file]: ../../etcd.conf.yml.sample