Skip to content

[DOCS] [7.8] Clarifying env variable substitution (#57370) #57733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/reference/setup/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,21 @@ 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
Expand All @@ -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`.
Expand Down