From 253d1d415a4931b08ce815553fef7fedfe8b5b73 Mon Sep 17 00:00:00 2001 From: "Sahdev P. Zala" Date: Sun, 24 Dec 2017 19:28:28 -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 | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Documentation/op-guide/configuration.md b/Documentation/op-guide/configuration.md index 9dc2bf02597..4286be19a13 100644 --- a/Documentation/op-guide/configuration.md +++ b/Documentation/op-guide/configuration.md @@ -2,9 +2,10 @@ etcd is configurable through a configuration file, various command-line flags, and environment variables. -A reusable configuration file is a YAML file made 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. +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 will be ignored. +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.