[DOCS] Deprecate transient settings#79167
Conversation
This PR adds documentation on deprecating the use of transient cluster settings, in favor of persistent settings.
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
|
Pinging @elastic/es-docs (Team:Docs) |
|
Hi @jrodewig, I am new here at Elastic and I was told to tag you for docs PR reviews. We won't be removing this feature in 8.0, do I need to do anything on the 8.0 side for the docs? |
jrodewig
left a comment
There was a problem hiding this comment.
LGTM. I left a few minor nits, but they aren't blocking. Thanks!
| [[breaking_716_settings_deprecations]] | ||
| ==== Settings deprecations |
There was a problem hiding this comment.
We should add * <<breaking_716_settings_deprecations>> to the unordered list at the top of this file.
| To avoid deprecation warnings, discontinue use of transient settings when modifying | ||
| your cluster settings through the `PUT _cluster/settings` REST API. When modifying cluster settings | ||
| use only persistent settings. |
There was a problem hiding this comment.
| To avoid deprecation warnings, discontinue use of transient settings when modifying | |
| your cluster settings through the `PUT _cluster/settings` REST API. When modifying cluster settings | |
| use only persistent settings. | |
| To avoid deprecation warnings, don't configure new transient settings using the | |
| {ref}/cluster-update-settings.html[update cluster settings API]. Use persistent | |
| settings instead. |
I assume ES only emits a deprecation warning if you add a new transient setting.
Let me know if it also emits a warning for any existing transient settings. I think your transient settings get erased during an upgrade, but I could be wrong.
There was a problem hiding this comment.
Correct, only adds a warning for newly added transient settings.
Nope. If we're adding the deprecation in 7.16, this and #78794 should suffice. |
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
This PR adds the deprecation documentation for transient cluster settings.
It relates to #49540 and it should be merged after #78794 is merged and back ported to 7.x