Browse Source

[DOCS] Document `dynamic` and `static` setting types (#56919)

James Rodewig 5 years ago
parent
commit
b8a4e00b11

+ 0 - 3
docs/reference/cluster/update-settings.asciidoc

@@ -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
 settings on different nodes by accident using the configuration file, it is very
 difficult to notice these discrepancies.
 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]]
 [[cluster-update-settings-api-query-params]]
 ==== {api-query-parms-title}
 ==== {api-query-parms-title}

+ 27 - 0
docs/reference/setup/configuration.asciidoc

@@ -78,3 +78,30 @@ variable, for instance:
 node.name:    ${HOSTNAME}
 node.name:    ${HOSTNAME}
 network.host: ${ES_NETWORK_HOST}
 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: 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.