honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update update-settings.asciidoc (#31378)

This commit is contained in:
mzbeck 2018-07-26 08:15:10 -07:00 committed by Christoph Büscher
parent 35ae87125d
commit 63a0436764
1 changed files with 34 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
docs/reference/cluster/update-settings.asciidoc
View File

@ -1,9 +1,18 @@
[[cluster-update-settings]] [[cluster-update-settings]]
== Cluster Update Settings == Cluster Update Settings
Allows to update cluster wide specific settings. Settings updated can Use this API to review and change cluster-wide settings.
either be persistent (applied across restarts) or transient (will not
survive a full cluster restart). Here is an example: To review cluster settings:
[source,js]
--------------------------------------------------
GET /_cluster/settings
--------------------------------------------------
// CONSOLE
Updates to settings can be persistent, meaning they apply across restarts, or transient, where they don't
survive a full cluster restart. Here is an example of a persistent update:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -16,7 +25,7 @@ PUT /_cluster/settings
-------------------------------------------------- --------------------------------------------------
// CONSOLE // CONSOLE
Or: This update is transient:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -29,8 +38,7 @@ PUT /_cluster/settings?flat_settings=true
-------------------------------------------------- --------------------------------------------------
// CONSOLE // CONSOLE
The cluster responds with the settings updated. So the response for the The response to an update returns the changed setting, as in this response to the transient example:
last example will be:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -44,11 +52,14 @@ last example will be:
-------------------------------------------------- --------------------------------------------------
// TESTRESPONSE[s/\.\.\./"acknowledged": true,/] // TESTRESPONSE[s/\.\.\./"acknowledged": true,/]
Resetting persistent or transient settings can be done by assigning a You can reset persistent or transient settings by assigning a
`null` value. If a transient setting is reset, the persistent setting `null` value. If a transient setting is reset, the first one of these values that is defined is applied:
is applied if available. Otherwise Elasticsearch will fallback to the setting
defined at the configuration file or, if not existent, to the default * the persistent setting
value. Here is an example: * the setting in the configuration file
* the default value.
This example resets a setting:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -61,8 +72,7 @@ PUT /_cluster/settings
-------------------------------------------------- --------------------------------------------------
// CONSOLE // CONSOLE
Reset settings will not be included in the cluster response. So The response does not include settings that have been reset:
the response for the last example will be:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -74,8 +84,8 @@ the response for the last example will be:
-------------------------------------------------- --------------------------------------------------
// TESTRESPONSE[s/\.\.\./"acknowledged": true,/] // TESTRESPONSE[s/\.\.\./"acknowledged": true,/]
Settings can also be reset using simple wildcards. For instance to reset You can also reset settings using wildcards. For example, to reset
all dynamic `indices.recovery` setting a prefix can be used: all dynamic `indices.recovery` settings:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -88,25 +98,19 @@ PUT /_cluster/settings
-------------------------------------------------- --------------------------------------------------
// CONSOLE // CONSOLE
Cluster wide settings can be returned using:
[source,js]
--------------------------------------------------
GET /_cluster/settings
--------------------------------------------------
// CONSOLE
[float] [float]
=== Precedence of settings === Order of Precedence
Transient cluster settings take precedence over persistent cluster settings, The order of precedence for cluster settings is:
which take precedence over settings configured in the `elasticsearch.yml`
config file.
For this reason it is preferrable to use the `elasticsearch.yml` file only 1. transient cluster settings
for local configurations, and set all cluster-wider settings with the 2. persistent cluster settings
3. settings in the `elasticsearch.yml` configuration file.
It's best to use the `elasticsearch.yml` file only
for local configurations, and set all cluster-wide settings with the
`settings` API. `settings` API.
A list of dynamically updatable settings can be found in the You can find the list of settings that you can dynamically update in <<modules,Modules>>.
<<modules,Modules>> documentation.