2015-01-25 06:19:16 +03:00
|
|
|
// Copyright 2015 CoreOS, Inc.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
2014-12-05 04:07:04 +03:00
|
|
|
package etcdmain
|
|
|
|
|
|
|
|
var (
|
|
|
|
usageline = `usage: etcd [flags]
|
|
|
|
start an etcd server
|
|
|
|
|
|
|
|
etcd --version
|
|
|
|
show the version of etcd
|
|
|
|
|
|
|
|
etcd -h | --help
|
|
|
|
show the help information about etcd
|
|
|
|
`
|
|
|
|
flagsline = `
|
|
|
|
member flags:
|
|
|
|
|
|
|
|
--name 'default'
|
|
|
|
human-readable name for this member.
|
|
|
|
--data-dir '${name}.etcd'
|
|
|
|
path to the data directory.
|
2015-09-01 01:01:18 +03:00
|
|
|
--wal-dir ''
|
|
|
|
path to the dedicated wal directory.
|
2014-12-05 04:07:04 +03:00
|
|
|
--snapshot-count '10000'
|
|
|
|
number of committed transactions to trigger a snapshot to disk.
|
2015-01-15 22:11:33 +03:00
|
|
|
--heartbeat-interval '100'
|
|
|
|
time (in milliseconds) of a heartbeat interval.
|
|
|
|
--election-timeout '1000'
|
2015-07-24 00:48:11 +03:00
|
|
|
time (in milliseconds) for an election to timeout. See tuning documentation for details.
|
2014-12-05 04:07:04 +03:00
|
|
|
--listen-peer-urls 'http://localhost:2380,http://localhost:7001'
|
|
|
|
list of URLs to listen on for peer traffic.
|
|
|
|
--listen-client-urls 'http://localhost:2379,http://localhost:4001'
|
|
|
|
list of URLs to listen on for client traffic.
|
|
|
|
-cors ''
|
|
|
|
comma-separated whitelist of origins for CORS (cross-origin resource sharing).
|
|
|
|
|
|
|
|
|
|
|
|
clustering flags:
|
|
|
|
|
|
|
|
--initial-advertise-peer-urls 'http://localhost:2380,http://localhost:7001'
|
2015-04-28 23:29:58 +03:00
|
|
|
list of this member's peer URLs to advertise to the rest of the cluster.
|
2014-12-05 04:07:04 +03:00
|
|
|
--initial-cluster 'default=http://localhost:2380,default=http://localhost:7001'
|
|
|
|
initial cluster configuration for bootstrapping.
|
|
|
|
--initial-cluster-state 'new'
|
|
|
|
initial cluster state ('new' or 'existing').
|
|
|
|
--initial-cluster-token 'etcd-cluster'
|
|
|
|
initial cluster token for the etcd cluster during bootstrap.
|
|
|
|
--advertise-client-urls 'http://localhost:2379,http://localhost:4001'
|
2015-04-26 18:15:19 +03:00
|
|
|
list of this member's client URLs to advertise to the public.
|
|
|
|
The client URLs advertised should be accessible to machines that talk to etcd cluster. etcd client libraries parse these URLs to connect to the cluster.
|
2014-12-05 04:07:04 +03:00
|
|
|
--discovery ''
|
|
|
|
discovery URL used to bootstrap the cluster.
|
|
|
|
--discovery-fallback 'proxy'
|
|
|
|
expected behavior ('exit' or 'proxy') when discovery services fails.
|
|
|
|
--discovery-proxy ''
|
|
|
|
HTTP proxy to use for traffic to discovery service.
|
2014-12-20 01:47:07 +03:00
|
|
|
--discovery-srv ''
|
2014-12-22 23:10:04 +03:00
|
|
|
dns srv domain used to bootstrap the cluster.
|
2015-09-18 08:05:57 +03:00
|
|
|
--strict-reconfig-check
|
|
|
|
reject reconfiguration requests that would cause quorum loss.
|
2014-12-05 04:07:04 +03:00
|
|
|
|
|
|
|
proxy flags:
|
|
|
|
|
|
|
|
--proxy 'off'
|
|
|
|
proxy mode setting ('off', 'readonly' or 'on').
|
2015-06-12 21:35:38 +03:00
|
|
|
--proxy-failure-wait 5000
|
|
|
|
time (in milliseconds) an endpoint will be held in a failed state.
|
|
|
|
--proxy-refresh-interval 30000
|
|
|
|
time (in milliseconds) of the endpoints refresh interval.
|
|
|
|
--proxy-dial-timeout 1000
|
|
|
|
time (in milliseconds) for a dial to timeout.
|
|
|
|
--proxy-write-timeout 5000
|
|
|
|
time (in milliseconds) for a write to timeout.
|
|
|
|
--proxy-read-timeout 0
|
|
|
|
time (in milliseconds) for a read to timeout.
|
2014-12-05 04:07:04 +03:00
|
|
|
|
|
|
|
|
|
|
|
security flags:
|
|
|
|
|
2015-04-07 01:26:41 +03:00
|
|
|
--ca-file '' [DEPRECATED]
|
2015-08-14 23:58:22 +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.
|
2014-12-05 04:07:04 +03:00
|
|
|
--cert-file ''
|
|
|
|
path to the client server TLS cert file.
|
|
|
|
--key-file ''
|
|
|
|
path to the client server TLS key file.
|
2015-03-13 08:26:46 +03:00
|
|
|
--client-cert-auth 'false'
|
|
|
|
enable client cert authentication.
|
|
|
|
--trusted-ca-file ''
|
|
|
|
path to the client server TLS trusted CA key file.
|
2015-04-07 01:26:41 +03:00
|
|
|
--peer-ca-file '' [DEPRECATED]
|
2015-08-14 23:58:22 +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.
|
2014-12-05 04:07:04 +03:00
|
|
|
--peer-cert-file ''
|
|
|
|
path to the peer server TLS cert file.
|
|
|
|
--peer-key-file ''
|
|
|
|
path to the peer server TLS key file.
|
2015-03-13 08:26:46 +03:00
|
|
|
--peer-client-cert-auth 'false'
|
|
|
|
enable peer client cert authentication.
|
|
|
|
--peer-trusted-ca-file ''
|
|
|
|
path to the peer server TLS trusted CA file.
|
2014-12-05 04:07:04 +03:00
|
|
|
|
2015-04-28 23:29:58 +03:00
|
|
|
logging flags
|
|
|
|
|
|
|
|
--debug 'false'
|
|
|
|
enable debug-level logging for etcd.
|
|
|
|
--log-package-levels ''
|
2015-10-25 16:31:37 +03:00
|
|
|
specify a particular log level for each etcd package (eg: 'etcdmain=CRITICAL,etcdserver=DEBUG').
|
2014-12-05 04:07:04 +03:00
|
|
|
|
|
|
|
unsafe flags:
|
|
|
|
|
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.
|
2015-04-28 23:29:58 +03:00
|
|
|
|
2014-12-05 04:07:04 +03:00
|
|
|
--force-new-cluster 'false'
|
|
|
|
force to create a new one-member cluster.
|
2015-08-10 19:53:17 +03:00
|
|
|
|
|
|
|
|
|
|
|
experimental flags:
|
|
|
|
|
|
|
|
--experimental-v3demo 'false'
|
2015-10-25 16:31:37 +03:00
|
|
|
enable experimental v3 demo API.
|
|
|
|
--experimental-gRPC-addr '127.0.0.1:2378'
|
|
|
|
gRPC address for experimental v3 demo API.
|
2014-12-05 04:07:04 +03:00
|
|
|
`
|
|
|
|
)
|