Browse Source

Merge pull request #8635 from gyuho/options

Documentation/op-guide: add missing flags to configuration.md
Gyu-Ho Lee 8 years ago
parent
commit
c6e7d3ab7d
1 changed files with 70 additions and 17 deletions
  1. 70 17
      Documentation/op-guide/configuration.md

+ 70 - 17
Documentation/op-guide/configuration.md

@@ -69,9 +69,39 @@ To start etcd automatically using custom settings at startup in Linux, using a [
 
 
 ### --cors
 ### --cors
 + Comma-separated white list of origins for CORS (cross-origin resource sharing).
 + Comma-separated white list of origins for CORS (cross-origin resource sharing).
-+ default: none
++ default: ""
 + env variable: ETCD_CORS
 + env variable: ETCD_CORS
 
 
+### --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
+
 ## Clustering flags
 ## Clustering flags
 
 
 `--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.
 `--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.
@@ -112,12 +142,12 @@ To start etcd automatically using custom settings at startup in Linux, using a [
 
 
 ### --discovery
 ### --discovery
 + Discovery URL used to bootstrap the cluster.
 + Discovery URL used to bootstrap the cluster.
-+ default: none
++ default: ""
 + env variable: ETCD_DISCOVERY
 + env variable: ETCD_DISCOVERY
 
 
 ### --discovery-srv
 ### --discovery-srv
 + DNS srv domain used to bootstrap the cluster.
 + DNS srv domain used to bootstrap the cluster.
-+ default: none
++ default: ""
 + env variable: ETCD_DISCOVERY_SRV
 + env variable: ETCD_DISCOVERY_SRV
 
 
 ### --discovery-fallback
 ### --discovery-fallback
@@ -127,7 +157,7 @@ To start etcd automatically using custom settings at startup in Linux, using a [
 
 
 ### --discovery-proxy
 ### --discovery-proxy
 + HTTP proxy to use for traffic to discovery service.
 + HTTP proxy to use for traffic to discovery service.
-+ default: none
++ default: ""
 + env variable: ETCD_DISCOVERY_PROXY
 + env variable: ETCD_DISCOVERY_PROXY
 
 
 ### --strict-reconfig-check
 ### --strict-reconfig-check
@@ -140,6 +170,10 @@ To start etcd automatically using custom settings at startup in Linux, using a [
 + default: 0
 + default: 0
 + env variable: ETCD_AUTO_COMPACTION_RETENTION
 + env variable: ETCD_AUTO_COMPACTION_RETENTION
 
 
+### --auto-compaction-mode
++ 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.
++ default: periodic
++ env variable: ETCD_AUTO_COMPACTION_MODE
 
 
 ### --enable-v2
 ### --enable-v2
 + Accept etcd V2 client requests
 + Accept etcd V2 client requests
@@ -185,22 +219,22 @@ To start etcd automatically using custom settings at startup in Linux, using a [
 
 
 The security flags help to [build a secure etcd cluster][security].
 The security flags help to [build a secure etcd cluster][security].
 
 
-### --ca-file 
+### --ca-file
 
 
 **DEPRECATED**
 **DEPRECATED**
 
 
 + 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.
 + 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.
-+ default: none
++ default: ""
 + env variable: ETCD_CA_FILE
 + env variable: ETCD_CA_FILE
 
 
 ### --cert-file
 ### --cert-file
 + Path to the client server TLS cert file.
 + Path to the client server TLS cert file.
-+ default: none
++ default: ""
 + env variable: ETCD_CERT_FILE
 + env variable: ETCD_CERT_FILE
 
 
 ### --key-file
 ### --key-file
 + Path to the client server TLS key file.
 + Path to the client server TLS key file.
-+ default: none
++ default: ""
 + env variable: ETCD_KEY_FILE
 + env variable: ETCD_KEY_FILE
 
 
 ### --client-cert-auth
 ### --client-cert-auth
@@ -208,9 +242,14 @@ The security flags help to [build a secure etcd cluster][security].
 + default: false
 + default: false
 + env variable: ETCD_CLIENT_CERT_AUTH
 + env variable: ETCD_CLIENT_CERT_AUTH
 
 
+### --client-crl-file
++ Path to the client certificate revocation list file.
++ default: ""
++ env variable: ETCD_CLIENT_CRL_FILE
+
 ### --trusted-ca-file
 ### --trusted-ca-file
 + Path to the client server TLS trusted CA key file.
 + Path to the client server TLS trusted CA key file.
-+ default: none
++ default: ""
 + env variable: ETCD_TRUSTED_CA_FILE
 + env variable: ETCD_TRUSTED_CA_FILE
 
 
 ### --auto-tls
 ### --auto-tls
@@ -218,22 +257,22 @@ The security flags help to [build a secure etcd cluster][security].
 + default: false
 + default: false
 + env variable: ETCD_AUTO_TLS
 + env variable: ETCD_AUTO_TLS
 
 
-### --peer-ca-file 
+### --peer-ca-file
 
 
 **DEPRECATED**
 **DEPRECATED**
 
 
 + 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.
 + 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.
-+ default: none
++ default: ""
 + env variable: ETCD_PEER_CA_FILE
 + env variable: ETCD_PEER_CA_FILE
 
 
 ### --peer-cert-file
 ### --peer-cert-file
 + Path to the peer server TLS cert file.
 + Path to the peer server TLS cert file.
-+ default: none
++ default: ""
 + env variable: ETCD_PEER_CERT_FILE
 + env variable: ETCD_PEER_CERT_FILE
 
 
 ### --peer-key-file
 ### --peer-key-file
 + Path to the peer server TLS key file.
 + Path to the peer server TLS key file.
-+ default: none
++ default: ""
 + env variable: ETCD_PEER_KEY_FILE
 + env variable: ETCD_PEER_KEY_FILE
 
 
 ### --peer-client-cert-auth
 ### --peer-client-cert-auth
@@ -241,9 +280,14 @@ The security flags help to [build a secure etcd cluster][security].
 + default: false
 + default: false
 + env variable: ETCD_PEER_CLIENT_CERT_AUTH
 + env variable: ETCD_PEER_CLIENT_CERT_AUTH
 
 
+### --peer-crl-file
++ Path to the peer certificate revocation list file.
++ default: ""
++ env variable: ETCD_PEER_CRL_FILE
+
 ### --peer-trusted-ca-file
 ### --peer-trusted-ca-file
 + Path to the peer server TLS trusted CA file.
 + Path to the peer server TLS trusted CA file.
-+ default: none
++ default: ""
 + env variable: ETCD_PEER_TRUSTED_CA_FILE
 + env variable: ETCD_PEER_TRUSTED_CA_FILE
 
 
 ### --peer-auto-tls
 ### --peer-auto-tls
@@ -260,10 +304,9 @@ The security flags help to [build a secure etcd cluster][security].
 
 
 ### --log-package-levels
 ### --log-package-levels
 + Set individual etcd subpackages to specific log levels. An example being `etcdserver=WARNING,security=DEBUG`
 + Set individual etcd subpackages to specific log levels. An example being `etcdserver=WARNING,security=DEBUG`
-+ default: none (INFO for all packages)
++ default: "" (INFO for all packages)
 + env variable: ETCD_LOG_PACKAGE_LEVELS
 + env variable: ETCD_LOG_PACKAGE_LEVELS
 
 
-
 ## Unsafe flags
 ## Unsafe flags
 
 
 Please be CAUTIOUS when using unsafe flags because it will break the guarantees given by the consensus protocol.
 Please be CAUTIOUS when using unsafe flags because it will break the guarantees given by the consensus protocol.
@@ -283,7 +326,7 @@ Follow the instructions when using these flags.
 
 
 ### --config-file
 ### --config-file
 + Load server configuration from a file.
 + Load server configuration from a file.
-+ default: none
++ default: ""
 
 
 ## Profiling flags
 ## Profiling flags
 
 
@@ -295,6 +338,10 @@ Follow the instructions when using these flags.
 + Set level of detail for exported metrics, specify 'extensive' to include histogram metrics.
 + Set level of detail for exported metrics, specify 'extensive' to include histogram metrics.
 + default: basic
 + default: basic
 
 
+### --listen-metrics-urls
++ List of URLs to listen on for metrics.
++ default: ""
+
 ## Auth flags
 ## Auth flags
 
 
 ### --auth-token
 ### --auth-token
@@ -302,6 +349,12 @@ Follow the instructions when using these flags.
 + Example option of JWT: '--auth-token jwt,pub-key=app.rsa.pub,priv-key=app.rsa,sign-method=RS512'
 + Example option of JWT: '--auth-token jwt,pub-key=app.rsa.pub,priv-key=app.rsa,sign-method=RS512'
 + default: "simple"
 + default: "simple"
 
 
+##Eexperimental flags
+
+### --experimental-corrupt-check-time
++ Duration of time between cluster corruption check passes
++ default: 0s
+
 [build-cluster]: clustering.md#static
 [build-cluster]: clustering.md#static
 [reconfig]: runtime-configuration.md
 [reconfig]: runtime-configuration.md
 [discovery]: clustering.md#discovery
 [discovery]: clustering.md#discovery