Skip to content

Commit b5b0d82

Browse files
Christoph Büscherkcm
Christoph Büscher
authored andcommitted
[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 0d087a5 commit b5b0d82

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
@@ -110,9 +110,11 @@ The order of precedence for cluster settings is:
110110
2. persistent cluster settings
111111
3. settings in the `elasticsearch.yml` configuration file.
112112

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

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

0 commit comments

Comments
 (0)