Browse Source

[DOCS] Un-deprecate transient cluster settings (#80766) (#80780)

#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
James Rodewig 3 years ago
parent
commit
2f4143267e

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

@@ -48,9 +48,15 @@ PUT /_cluster/settings
 
 An example of a transient update:
 
-// tag::transient-settings-deprecation[]
-deprecated::[7.16,Transient settings are deprecated and will be removed in a future release. Use persistent cluster settings instead. See the <<transient-settings-migration-guide>>.]
-// end::transient-settings-deprecation[]
+// tag::transient-settings-warning[]
+[WARNING]
+====
+We no longer recommend using transient cluster settings. Use persistent cluster
+settings instead. If a cluster becomes unstable, transient settings can clear
+unexpectedly, resulting in a potentially undesired cluster configuration. See
+the <<transient-settings-migration-guide>>.
+====
+// end::transient-settings-warning[]
 
 [source,console]
 --------------------------------------------------

+ 7 - 10
docs/reference/migration/migrate_8_0.asciidoc

@@ -63,22 +63,19 @@ enable <<deprecation-logging, deprecation logging>>.
 ==== Cluster and node setting deprecations
 
 [[deprecate-transient-cluster-settings]]
-.Transient cluster settings are deprecated.
+.We no longer recommend using transient cluster settings.
 [%collapsible]
 ====
 *Details* +
-Starting in 7.16, transient cluster settings are deprecated and will be removed in a future release. This is because transient
-cluster settings have an unpredictable lifecycle. Transient cluster settings do not survive full cluster restarts or
-cluster instability. In these cases, {es} recovers the cluster state
-from persistent storage, effectively erasing the transient settings. The loss of transient settings can happen
-unexpectedly, leading to a potentially undesired cluster configuration.
+We no longer recommend using transient cluster settings. Use persistent cluster
+settings instead. If a cluster becomes unstable, transient settings can clear
+unexpectedly, resulting in an undesired cluster configuration.
 
 *Impact* +
-To avoid deprecation warnings, discontinue use of transient settings when modifying
-your cluster settings through the `PUT _cluster/settings` REST API. Use persistent
-settings instead. See the
+Transient cluster settings are not yet deprecated, but we plan to deprecate them
+in a future release. For migration steps, see the
 {ref}/transient-settings-migration-guide.html[Transient settings migration
-guide]. 
+guide].
 ====
 
 [discrete]

+ 2 - 4
docs/reference/migration/transient-settings-migration-guide.asciidoc

@@ -14,12 +14,12 @@ PUT _cluster/settings
 ----
 ////
 
-Transient cluster settings are deprecated. Previously, you could use transient
+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 deprecation warnings, reset any transient settings you've configured on
+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
@@ -60,8 +60,6 @@ steps.
 <<cluster-update-settings,cluster update settings API>> request. In the same
 request, reset any transient settings by assigning them a `null` value.
 +
-NOTE: Resetting transient settings will emit a deprecation warning.
-+
 [source,console]
 ----
 PUT _cluster/settings

+ 1 - 1
docs/reference/setup/configuration.asciidoc

@@ -148,7 +148,7 @@ doesn't require a restart and ensures a setting's value is the same on all
 nodes.
 ====
 
-include::{es-repo-dir}/cluster/update-settings.asciidoc[tag=transient-settings-deprecation]
+include::{es-repo-dir}/cluster/update-settings.asciidoc[tag=transient-settings-warning]
 --
 
 [[static-cluster-setting]]