feat(docs): add cluster config section

This commit is contained in:
Rob Szumski 2014-06-16 11:43:46 -07:00
parent fc2afe1ed2
commit d8a08f53e3

View File

@ -1,6 +1,8 @@
# Etcd Configuration # Etcd Configuration
Configuration options can be set in three places: ## Node Configuration
Individual node configuration options can be set in three places:
1. Command line flags 1. Command line flags
2. Environment variables 2. Environment variables
@ -10,6 +12,16 @@ Options set on the command line take precedence over all other sources.
Options set in environment variables take precedence over options set in Options set in environment variables take precedence over options set in
configuration files. configuration files.
## Cluster Configuration
Cluster-wide settings are configured via the `/config` admin endpoint and additionally in the configuration file. Values contained in the configuration file will seed the cluster setting with the provided value. After the cluster is running, only the admin endpoint is used.
The full documentation is contained in the [API docs](https://github.com/coreos/etcd/blob/master/Documentation/api.md#cluster-config).
* `activeSize` - the maximum number of peers that can participate in the consensus protocol. Other peers will join as standbys.
* `removeDelay` - the minimum time in seconds that a machine has been observed to be unresponsive before it is removed from the cluster.
* `syncInterval` - the amount of time in seconds between cluster sync when it runs in standby mode.
## Command Line Flags ## Command Line Flags
### Required ### Required