소스 검색

feat(docs): add cluster config section

Rob Szumski 11 년 전
부모
커밋
d8a08f53e3
1개의 변경된 파일13개의 추가작업 그리고 1개의 파일을 삭제
  1. 13 1
      Documentation/configuration.md

+ 13 - 1
Documentation/configuration.md

@@ -1,6 +1,8 @@
 # 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
  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
 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
 
 ### Required