Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc: update etcd configuration detail with config file

Browse Source 
Add a reference, sample file link and precedence detail etc. to the
configuration doc.
This commit is contained in:
Sahdev P. Zala 2017-12-24 12:03:13 -05:00
parent 0fd3df0b95
commit aad0d82a04
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/op-guide/configuration.md
View File

@ -1,6 +1,11 @@
# Configuration flags # 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. The format of environment variable for flag `--my-flag` is `ETCD_MY_FLAG`. It applies to all flags.
@ -332,6 +337,7 @@ Follow the instructions when using these flags.
### --config-file ### --config-file
+ Load server configuration from a file. + Load server configuration from a file.
+ default: "" + default: ""
+ example: [sample configuration file][sample-config-file]
## Profiling flags ## Profiling flags
@ -369,3 +375,4 @@ Follow the instructions when using these flags.
[security]: security.md [security]: security.md
[systemd-intro]: http://freedesktop.org/wiki/Software/systemd/ [systemd-intro]: http://freedesktop.org/wiki/Software/systemd/
[tuning]: ../tuning.md#time-parameters [tuning]: ../tuning.md#time-parameters
[sample-config-file]: ../../etcd.conf.yml.sample