1ETCD(1)                            Nov 2017                            ETCD(1)
2
3
4

NAME:

6       etcd  - Distributed reliable key-value store for the most critical data
7       of a distributed system
8
9

USAGE:

11       etcd [flags]
12
13

DESCRIPTION:

15       Etcd is a distributed key-value store designed to reliably and  quickly
16       preserve  and provide access to critical data. It enables reliable dis‐
17       tributed coordination through distributed  locking,  leader  elections,
18       and  write  barriers. An etcd cluster is intended for high availability
19       and permanent data storage and retrieval.
20
21

GENERAL OPTIONS

23       Member flags
24
25              --data-dir
26                    Path to the data directory.
27
28              --wal-dir
29                    Path to the dedicated wal directory.
30
31              --listen-peer-urls http://localhost:2380
32                    List of URLs to listen on for peer traffic.
33
34              --listen-client-urls http://localhost:2379
35                    List of URLs to listen on for client traffic.
36
37              --listen-metrics-urls
38                    List of URLs to listen on for the metrics and health  end‐
39              points.
40
41              --max-snapshots 5
42                    Maximum  number  of  snapshot files to retain (0 is unlim‐
43              ited).
44
45              --max-wals 5
46                    Maximum number of wal files to retain (0 is unlimited).
47
48              --name default
49                    Human-readable name for this member.
50
51              --snapshot-count 100000
52                    Number of committed transactions to trigger a snapshot  to
53              disk.
54
55              --heartbeat-interval 100
56                    Time (in milliseconds) of a heartbeat interval.
57
58              --election-timeout 1000
59                    Time (in milliseconds) for an election to timeout.
60
61              --initial-election-tick-advance true
62                    Whether to fast-forward initial election ticks on boot for
63              faster election.
64
65              --quota-backend-bytes 0
66                    Raise alarms when backend size exceeds the given quota.  0
67              means use the default quota.
68
69              --backend-batch-interval 0s
70                    BackendBatchInterval is the maximum time before commit the
71              backend transaction.
72
73              --backend-batch-limit 0
74                    BackendBatchLimit is the maximum operations before  commit
75              the backend transaction.
76
77              --max-txn-ops 128
78                    Maximum number of operations permitted in a transaction.
79
80              --max-request-bytes 1572864
81                    Maximum  client  request  size  in  bytes  the server will
82              accept.
83
84              --grpc-keepalive-min-time 5s
85                    Minimum interval duration that a client should wait before
86              pinging server.
87
88              --grpc-keepalive-interval 2h0m0s
89                    Frequency  duration of server-to-client ping to check if a
90              connection is alive (0 to disable).
91
92              --grpc-keepalive-timeout 20s
93                    Additional duration of wait before closing  a  non-respon‐
94              sive connection (0 to disable).
95
96       Clustering flags
97
98              --initial-advertise-peer-urls http://localhost:2380
99                    List  of  this member's peer URLs to advertise to the rest
100              of the cluster.
101
102              --advertise-client-urls http://localhost:2379
103                    List of this member's client URLs to advertise to the pub‐
104              lic.
105
106              --discovery
107                    Discovery URL used to bootstrap the cluster.
108
109              --discovery-fallback proxy
110                    Valid values include ["exit" "proxy"]
111
112              --discovery-proxy
113                    HTTP proxy to use for traffic to discovery service.
114
115              --discovery-srv
116                    DNS domain used to bootstrap initial cluster.
117
118              --discovery-srv-name
119                    Service name to query when using DNS discovery.
120
121              --initial-cluster default=http://localhost:2380
122                    Initial cluster configuration for bootstrapping.
123
124              --initial-cluster-token etcd-cluster
125                    Initial  cluster  token  for the etcd cluster during boot‐
126              strap.
127
128              --initial-cluster-state new
129                    Initial cluster state ('new' or 'existing').
130
131              --strict-reconfig-check true
132                    Reject reconfiguration requests that  would  cause  quorum
133              loss.
134
135              --enable-v2 true
136                    Accept etcd V2 client requests.
137
138              --pre-vote false
139                    Enable to run an additional Raft election phase.
140
141       Proxy flags
142
143              --proxy off
144                    Valid values include ["off" "on" "readonly"]
145
146              --proxy-failure-wait 5000
147                    Time  (in  milliseconds)  an  endpoint  will  be held in a
148              failed state.
149
150              --proxy-refresh-interval 30000
151                    Time (in milliseconds) of the endpoints refresh interval.
152
153              --proxy-dial-timeout 1000
154                    Time (in milliseconds) for a dial to timeout.
155
156              --proxy-write-timeout 5000
157                    Time (in milliseconds) for a write to timeout.
158
159              --proxy-read-timeout 0
160                    Time (in milliseconds) for a read to timeout.
161
162       Security flags
163
164              --cert-file
165                    Path to the client server TLS cert file.
166
167              --key-file
168                    Path to the client server TLS key file.
169
170              --client-cert-auth false
171                    Enable client cert authentication.
172
173              --client-crl-file
174                    Path to the client certificate revocation list file.
175
176              --trusted-ca-file
177                    Path to the client server TLS trusted CA cert file.
178
179              --auto-tls false
180                    Client TLS using generated certificates
181
182              --peer-cert-file
183                    Path to the peer server TLS cert file.
184
185              --peer-key-file
186                    Path to the peer server TLS key file.
187
188              --peer-client-cert-auth false
189                    Enable peer client cert authentication.
190
191              --peer-trusted-ca-file
192                    Path to the peer server TLS trusted CA file.
193
194              --peer-auto-tls false
195                    Peer TLS using generated certificates
196
197              --peer-crl-file
198                    Path to the peer certificate revocation list file.
199
200              --peer-cert-allowed-cn
201                    Allowed CN for inter peer authentication.
202
203              --cipher-suites
204                    Comma-separated  list  of  supported  TLS  cipher   suites
205              between client/server and peers (empty will be auto-populated by
206              Go).
207
208              --cors *
209                    Comma-separated white list of origins for CORS, or  cross-
210              origin resource sharing, (empty or * means allow all)
211
212              --host-whitelist *
213                    Comma-separated  acceptable  hostnames  from  HTTP  client
214              requests, if server is not secure (empty means allow all).
215
216       Logging flags
217
218              --logger capnslog
219                    Specify 'zap' for structured logging or 'capnslog'.
220
221              --log-output default
222                    DEPRECATED: use '--log-outputs'.
223
224              --log-outputs default
225                    Specify 'stdout' or 'stderr' to skip journald logging even
226              when  running  under  systemd, or list of comma separated output
227              targets.
228
229              --debug false
230                    Enable debug-level logging for etcd.
231
232              --log-package-levels
233                    (To be deprecated) Specify a particular log level for each
234              etcd package (eg: 'etcdmain=CRITICAL,etcdserver=DEBUG').
235
236       Version flags
237
238              --version false
239                    Print the version and exit.
240
241              --auto-compaction-retention 0
242                    Auto  compaction  retention  for  mvcc  key value store. 0
243              means disable auto compaction.
244
245              --auto-compaction-mode periodic
246                    interpret  'auto-compaction-retention'   one   of:   peri‐
247              odic|revision. 'periodic' for duration based retention, default‐
248              ing to hours if no time unit is provided (e.g. '5m'). 'revision'
249              for revision number based retention.
250
251       Profiling flags
252
253              --enable-pprof false
254                    Enable  runtime profiling data via HTTP server. Address is
255              at client URL + "/debug/pprof/"
256
257              --metrics basic
258                    Set level of detail for exported metrics, specify  'exten‐
259              sive' to include histogram metrics
260
261       Auth flags
262
263              --auth-token simple
264                    Specify auth token specific options.
265
266              --bcrypt-cost 10
267                    Specify  bcrypt  algorithm  cost  factor for auth password
268              hashing.
269
270       Gateway flags
271
272              --enable-grpc-gateway true
273                    Enable GRPC gateway.
274
275       Experimental flags
276
277              --experimental-initial-corrupt-check false
278                    Enable  to  check  data  corruption  before  serving   any
279              client/peer traffic.
280
281              --experimental-corrupt-check-time 0s
282                    Duration of time between cluster corruption check passes.
283
284              --experimental-enable-v2v3
285                    v3 prefix for serving emulated v2 state.
286
287              --experimental-backend-bbolt-freelist-type
288                    ExperimentalBackendFreelistType   specifies  the  type  of
289              freelist that boltdb backend uses(array and  map  are  supported
290              types)
291
292       Unsafe flags
293
294              --force-new-cluster false
295                    Force to create a new one member cluster.
296
297

SEE ALSO:

299       etcdctl(1), etcdctl2(1), etcdctl3(1)
300
301
302
303
304Etcd contributors              etcd User Manuals                       ETCD(1)
Impressum