[DOCS] Document dynamic and static setting types () ()

This commit is contained in:
James Rodewig 2020-06-01 14:19:52 -04:00 committed by GitHub
parent c6c0b1a968
commit 12813d5918
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 3 deletions

@ -40,9 +40,6 @@ the setting is the same on all nodes. If, on the other hand, you define differen
settings on different nodes by accident using the configuration file, it is very
difficult to notice these discrepancies.
You can find the list of settings that you can dynamically update in
<<modules,Modules>>.
[[cluster-update-settings-api-query-params]]
==== {api-query-parms-title}

@ -78,3 +78,30 @@ variable, for instance:
node.name: ${HOSTNAME}
network.host: ${ES_NETWORK_HOST}
--------------------------------------------------
[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
<<cluster-update-settings,cluster update settings API>>.
+
You can also configure dynamic settings locally on an unstarted or shut down
node using `elasticsearch.yml`.
+
TIP: Its 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.