mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
2f4143267e
#80556 reverted the deprecation of transient cluster settings. This replaces deprecation language in the docs with a warning/recommendation to avoid transient settings. Closes #80557 # Conflicts: # docs/reference/migration/migrate_7_16.asciidoc
116 lines
2.9 KiB
Text
116 lines
2.9 KiB
Text
[[transient-settings-migration-guide]]
|
|
=== Transient settings migration guide
|
|
|
|
////
|
|
[source,console]
|
|
----
|
|
PUT _cluster/settings
|
|
{
|
|
"transient": {
|
|
"cluster.indices.close.enable": false,
|
|
"indices.recovery.max_bytes_per_sec": "50mb"
|
|
}
|
|
}
|
|
----
|
|
////
|
|
|
|
We no longer recommend using transient cluster settings. You can use transient
|
|
settings to make temporary configuration changes to a cluster. However, a
|
|
cluster restart or cluster instability can unexpectedly clear these settings,
|
|
leading to a potentially undesired cluster configuration.
|
|
|
|
To avoid this risk, reset any transient settings you've configured on
|
|
your cluster. Convert any transient setting you'd like to keep to a persistent
|
|
setting, which persists across cluster restarts and cluster instability. You
|
|
should also update any custom workflows and applications to use persistent
|
|
settings instead of transient settings.
|
|
|
|
IMPORTANT: Some Elastic products may use transient settings when performing
|
|
specific operations. Only reset transient settings configured by you, your
|
|
users, or your custom workflows and applications.
|
|
|
|
To reset and convert transient settings:
|
|
|
|
. Get a list of any configured transient settings using the
|
|
<<cluster-get-settings,cluster get settings API>>.
|
|
+
|
|
[source,console]
|
|
----
|
|
GET _cluster/settings?flat_settings=true&filter_path=transient
|
|
----
|
|
// TEST[continued]
|
|
+
|
|
The API returns transient settings in the `transient` object. If this object is
|
|
empty, your cluster has no transient settings, and you can skip the remaining
|
|
steps.
|
|
+
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"persistent": { ... },
|
|
"transient": {
|
|
"cluster.indices.close.enable": "false",
|
|
"indices.recovery.max_bytes_per_sec": "50mb"
|
|
}
|
|
}
|
|
----
|
|
// TESTRESPONSE[s/"persistent": \{ \.\.\. \},//]
|
|
|
|
. Copy any settings you'd like to convert into the `persistent` object of a
|
|
<<cluster-update-settings,cluster update settings API>> request. In the same
|
|
request, reset any transient settings by assigning them a `null` value.
|
|
+
|
|
[source,console]
|
|
----
|
|
PUT _cluster/settings
|
|
{
|
|
"persistent": {
|
|
"cluster.indices.close.enable": false,
|
|
"indices.recovery.max_bytes_per_sec": "50mb"
|
|
},
|
|
"transient": {
|
|
"*": null
|
|
}
|
|
}
|
|
----
|
|
// TEST[continued]
|
|
|
|
. Use the <<cluster-get-settings,cluster get settings API>> to confirm your
|
|
cluster has no remaining transient settings.
|
|
+
|
|
[source,console]
|
|
----
|
|
GET _cluster/settings?flat_settings=true
|
|
----
|
|
// TEST[continued]
|
|
+
|
|
If the `transient` object is empty, your cluster has no transient settings.
|
|
+
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"persistent": {
|
|
"cluster.indices.close.enable": "false",
|
|
"indices.recovery.max_bytes_per_sec": "50mb",
|
|
...
|
|
},
|
|
"transient": {
|
|
}
|
|
}
|
|
----
|
|
// TESTRESPONSE[s/"50mb",/"50mb"/]
|
|
// TESTRESPONSE[s/\.\.\.//]
|
|
|
|
////
|
|
[source,console]
|
|
----
|
|
PUT _cluster/settings
|
|
{
|
|
"persistent" : {
|
|
"cluster.indices.close.enable": null,
|
|
"indices.recovery.max_bytes_per_sec": null
|
|
}
|
|
}
|
|
----
|
|
// TEST[continued]
|
|
////
|