"Fossies" - the Fresh Open Source Software Archive

Member "etcd-3.4.9/Documentation/op-guide/configuration.md" (20 May 2020, 19084 Bytes) of package /linux/misc/etcd-3.4.9.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.


title: Configuration flags

etcd is configurable through a configuration file, various command-line flags, and environment variables.

A reusable configuration file is a YAML file made with name and value of one or more command-line flags described below. In order to use this file, specify the file path as a value to the --config-file flag or ETCD_CONFIG_FILE environment variable. The sample configuration file can be used as a starting point to create a new configuration file as needed.

Options set on the command line take precedence over those from the environment. If a configuration file is provided, other command line flags and environment variables will be ignored. For example, etcd --config-file etcd.conf.yml.sample --data-dir /tmp will ignore the --data-dir flag.

The format of environment variable for flag --my-flag is ETCD_MY_FLAG. It applies to all flags.

The official etcd ports are 2379 for client requests and 2380 for peer communication. The etcd ports can be set to accept TLS traffic, non-TLS traffic, or both TLS and non-TLS traffic.

To start etcd automatically using custom settings at startup in Linux, using a systemd unit is highly recommended.

Member flags

--name

--data-dir

--wal-dir

--snapshot-count

--heartbeat-interval

--election-timeout

--listen-peer-urls

--listen-client-urls

--max-snapshots

--max-wals

--cors

--quota-backend-bytes

--backend-batch-limit

--backend-batch-interval

--max-txn-ops

--max-request-bytes

--grpc-keepalive-min-time

--grpc-keepalive-interval

--grpc-keepalive-timeout

Clustering flags

--initial-advertise-peer-urls, --initial-cluster, --initial-cluster-state, and --initial-cluster-token flags are used in bootstrapping (static bootstrap, discovery-service bootstrap or runtime reconfiguration) a new member, and ignored when restarting an existing member.

--discovery prefix flags need to be set when using discovery service.

--initial-advertise-peer-urls

--initial-cluster

--initial-cluster-state

--initial-cluster-token

--advertise-client-urls

--discovery

--discovery-srv

--discovery-srv-name

--discovery-fallback

--discovery-proxy

--strict-reconfig-check

--auto-compaction-retention

--auto-compaction-mode

--enable-v2

Proxy flags

--proxy prefix flags configures etcd to run in proxy mode. "proxy" supports v2 API only.

--proxy

--proxy-failure-wait

--proxy-refresh-interval

--proxy-dial-timeout

--proxy-write-timeout

--proxy-read-timeout

Security flags

The security flags help to build a secure etcd cluster.

--ca-file

DEPRECATED

--cert-file

--key-file

--client-cert-auth

--client-crl-file

--client-cert-allowed-hostname

--trusted-ca-file

--auto-tls

--peer-ca-file

DEPRECATED

--peer-cert-file

--peer-key-file

--peer-client-cert-auth

--peer-crl-file

--peer-trusted-ca-file

--peer-auto-tls

--peer-cert-allowed-cn

--peer-cert-allowed-hostname

--cipher-suites

Logging flags

--logger

Available from v3.4. WARNING: --logger=capnslog to be deprecated in v3.5.

--log-outputs

--log-level

Available from v3.4.

--debug

WARNING: to be deprecated in v3.5.

--log-package-levels

WARNING: to be deprecated in v3.5.

Unsafe flags

Please be CAUTIOUS when using unsafe flags because it will break the guarantees given by the consensus protocol. For example, it may panic if other members in the cluster are still alive. Follow the instructions when using these flags.

--force-new-cluster

Miscellaneous flags

--version

--config-file

Profiling flags

--enable-pprof

--metrics

--listen-metrics-urls

Auth flags

--auth-token

--bcrypt-cost

Experimental flags

--experimental-backend-bbolt-freelist-type

--experimental-corrupt-check-time

--experimental-compaction-batch-limit

--experimental-peer-skip-client-san-verification