[DOCS] Clarifying env variable substitution (#57370) (#57737)

* Clarifying environment variable substitution in the ES configuration YAML
* Update code snippet
* Remove extraneous quotes from string example
* Incorporating review feedback
This commit is contained in:
Adam Locke 2020-06-05 11:08:03 -04:00 committed by GitHub
parent 94b3eed6be
commit fe558f6373
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions

View File

@ -71,7 +71,7 @@ path.logs: /var/log/elasticsearch
Environment variables referenced with the `${...}` notation within the
configuration file will be replaced with the value of the environment
variable, for instance:
variable. For example:
[source,yaml]
--------------------------------------------------
@ -79,6 +79,13 @@ node.name: ${HOSTNAME}
network.host: ${ES_NETWORK_HOST}
--------------------------------------------------
Values for environment variables must be simple strings. Use a comma-separated string to provide values that Elasticsearch will parse as a list. For example, Elasticsearch will split the following string into a list of values for the `${HOSTNAME}` environment variable:
[source,yaml]
----
export HOSTNAME=“host1,host2"
----
[discrete]
[[cluster-setting-types]]
=== Cluster and node setting types
@ -88,7 +95,7 @@ Cluster and node settings can be categorized based on how they are configured:
[[dynamic-cluster-setting]]
Dynamic::
You can configure and update dynamic settings on a running cluster using the
<<cluster-update-settings,cluster update settings API>>.
<<cluster-update-settings,cluster update settings API>>.
+
You can also configure dynamic settings locally on an unstarted or shut down
node using `elasticsearch.yml`.