Skip to content

Commit

Permalink
Doc: update etcd configuration detail with config file
Browse files Browse the repository at this point in the history
Add a reference, sample file link and precedence detail etc. to the
configuration doc.
  • Loading branch information
spzala committed Dec 25, 2017
1 parent 0fd3df0 commit aad0d82
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion Documentation/op-guide/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Configuration flags

etcd is configurable through command-line flags and environment variables. Options set on the command line take precedence over those from the environment.
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. The [sample configuration file][sample-config-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.

Expand Down Expand Up @@ -332,6 +337,7 @@ Follow the instructions when using these flags.
### --config-file
+ Load server configuration from a file.
+ default: ""
+ example: [sample configuration file][sample-config-file]

## Profiling flags

Expand Down Expand Up @@ -369,3 +375,4 @@ Follow the instructions when using these flags.
[security]: security.md
[systemd-intro]: http://freedesktop.org/wiki/Software/systemd/
[tuning]: ../tuning.md#time-parameters
[sample-config-file]: ../../etcd.conf.yml.sample

0 comments on commit aad0d82

Please sign in to comment.