Skip to content

Commit

Permalink
[DOCS] Un-deprecate transient cluster settings (#80766) (#80780)
Browse files Browse the repository at this point in the history
#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
  • Loading branch information
jrodewig authored Nov 16, 2021
1 parent debb882 commit 2f41432
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 18 deletions.
12 changes: 9 additions & 3 deletions docs/reference/cluster/update-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
--------------------------------------------------
Expand Down
17 changes: 7 additions & 10 deletions docs/reference/migration/migrate_8_0.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/setup/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down

0 comments on commit 2f41432

Please sign in to comment.