From aad0d82a04f195e44b0134a44da20ccb85ccd1a5 Mon Sep 17 00:00:00 2001 From: "Sahdev P. Zala" Date: Sun, 24 Dec 2017 12:03:13 -0500 Subject: [PATCH] Doc: update etcd configuration detail with config file Add a reference, sample file link and precedence detail etc. to the configuration doc. --- Documentation/op-guide/configuration.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/Documentation/op-guide/configuration.md b/Documentation/op-guide/configuration.md index 6d2d37d6f..4286be19a 100644 --- a/Documentation/op-guide/configuration.md +++ b/Documentation/op-guide/configuration.md @@ -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. @@ -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 @@ -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