Skip to content

Commit 7bf216f

Browse files
author
Christoph Büscher
authored
[Docs] Add reason to use Settings API over config file (#32405)
Extending the warning to prefer the `setttings` API over changes in the configuration file by giving reasons why this might be dangerous.
1 parent eae5487 commit 7bf216f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/reference/cluster/update-settings.asciidoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,11 @@ The order of precedence for cluster settings is:
108108
2. persistent cluster settings
109109
3. settings in the `elasticsearch.yml` configuration file.
110110

111-
It's best to use the `elasticsearch.yml` file only
112-
for local configurations, and set all cluster-wide settings with the
113-
`settings` API.
111+
It's best to set all cluster-wide settings with the `settings` API and use the
112+
`elasticsearch.yml` file only for local configurations. This way you can be sure that
113+
the setting is the same on all nodes. If, on the other hand, you define different
114+
settings on different nodes by accident using the configuration file, it is very
115+
difficult to notice these discrepancies.
114116

115117
You can find the list of settings that you can dynamically update in <<modules,Modules>>.
116118

0 commit comments

Comments
 (0)