diff --git a/docs/reference/setup/configuration.asciidoc b/docs/reference/setup/configuration.asciidoc index 04102c20d8738..5337522ade83f 100644 --- a/docs/reference/setup/configuration.asciidoc +++ b/docs/reference/setup/configuration.asciidoc @@ -71,10 +71,44 @@ 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] -------------------------------------------------- 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 + +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 +<>. ++ +You can also configure dynamic settings locally on an unstarted or shut down +node using `elasticsearch.yml`. ++ +TIP: It’s best to set dynamic, cluster-wide settings with the cluster update +settings API and use `elasticsearch.yml` only for local configurations. Using +the cluster update settings API ensures the setting is the same on all nodes. If +you accidentally configure different settings in `elasticsearch.yml` on +different nodes, it can be difficult to notice discrepancies. + +[[static-cluster-setting]] +Static:: +Static settings can only be configured on an unstarted or shut down node using +`elasticsearch.yml`. ++ +Static settings must be set on every relevant node in the cluster.