Deprecation of transient cluster settings #78794

grcevski · 2021-10-06T21:16:45Z

We are deprecating transient cluster settings in 7.16.0, so this PR adds the final deprecation warning.

I made few docs changes here to discourage use of transient settings where we don't need to.
After the deprecation is ported in 7.x, I'll submit a follow-up docs only PR for 7.x to add the 7.16
deprecation notice and make the deprecation link real.

Relates to #49540

We are deprecating transient settings, therefore this PR changes uses of transient cluster settings to persistent cluster settings.

Revert back tests that test specifically for the transient settings functionality.

…transient_cluster_settings

grcevski · 2021-10-13T21:25:21Z

...level/src/test/java/org/elasticsearch/client/documentation/ClusterClientDocumentationIT.java

@@ -35,6 +35,7 @@
 import org.elasticsearch.cluster.metadata.AliasMetadata;
 import org.elasticsearch.cluster.metadata.ComponentTemplate;
 import org.elasticsearch.cluster.metadata.Template;
+import org.elasticsearch.cluster.routing.allocation.decider.EnableAllocationDecider;


The changes in this file are actually a revert from my previous PR (#78562), since we are keeping the docs for transient settings this should also have the transient settings. I'm actually not sure how did the docs CI job pass for #78562, it should've failed for put_settings.asciidoc after I reverted those updates. I noticed it in my 7.x back port.

elasticmachine · 2021-10-14T18:48:15Z

Pinging @elastic/clients-team (Team:Clients)

grcevski · 2021-10-14T20:38:26Z

@elasticmachine run elasticsearch-ci/part-1

rjernst

LGTM, just a minor comment about the deprecation message itself.

rjernst · 2021-10-14T22:44:02Z

...c/main/java/org/elasticsearch/rest/action/admin/cluster/RestClusterUpdateSettingsAction.java

@@ -25,6 +27,9 @@
 import static org.elasticsearch.rest.RestRequest.Method.PUT;

 public class RestClusterUpdateSettingsAction extends BaseRestHandler {
+    private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestClusterUpdateSettingsAction.class);
+    static final String TRANSIENT_SETTINGS_DEPRECATION_MESSAGE = "[transientSettings removal]" +
+        " Updating cluster settings through transientSettings is deprecated. Prefer using persistent settings instead.";


should it be transient settings rather than camelCase?

Also, instead of Prefer using... I would say Use ...

I'll change it, thanks!

rjernst · 2021-10-14T22:50:51Z

.../deprecation/src/main/java/org/elasticsearch/xpack/deprecation/ClusterDeprecationChecks.java

+            return new DeprecationIssue(DeprecationIssue.Level.WARNING,
+                "Transient cluster settings are in the process of being removed.",
+                "https://ela.st/es-deprecation-7-transient-cluster-settings",
+                "Prefer using persistent settings to define your cluster settings instead.",


Same comment, I think we should use active language, Use ...

grcevski · 2021-10-15T15:16:45Z

@elasticmachine update branch

elasticsearchmachine · 2021-10-15T17:01:48Z

💔 Backport failed

Status	Branch	Result
❌	7.x	Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 78794

This PR changes uses of transient cluster settings to persistent cluster settings. The PR also deprecates the transient settings usage. Relates to #49540

* upstream/master: (109 commits) Migrate custom role providers to licensed feature (elastic#79127) Remove stale AwaitsFix in InternalEngineTests (elastic#79323) Fix errors in RefreshListenersTests (elastic#79324) Reeable BwC Tests after elastic#79318 (elastic#79320) Mute BwC Tests for elastic#79318 (elastic#79319) Reenable BwC Tests after elastic#79308 (elastic#79313) Disable BwC Tests for elastic#79308 (elastic#79310) Adjust BWC for node-level field cap requests (elastic#79301) Allow total memory to be overridden (elastic#78750) Fix SnapshotBasedIndexRecoveryIT#testRecoveryIsCancelledAfterDeletingTheIndex (elastic#79269) Disable BWC tests Mute GeoIpDownloaderCliIT.testStartWithNoDatabases (elastic#79299) Add alias support to fleet search API (elastic#79285) Create a coordinating node level reader for tsdb (elastic#79197) Route documents to the correct shards in tsdb (elastic#77731) Inject migrate action regardless of allocate action (elastic#79090) Migrate to data tiers should always ensure a TIER_PREFERENCE is set (elastic#79100) Skip building of BWC distributions when building release artifacts (elastic#79180) Default ENFORCE_DEFAULT_TIER_PREFERENCE to true (elastic#79275) Deprecation of transient cluster settings (elastic#78794) ... # Conflicts: # server/src/main/java/org/elasticsearch/index/IndexMode.java # server/src/test/java/org/elasticsearch/index/TimeSeriesModeTests.java

* upstream/master: (521 commits) Migrate custom role providers to licensed feature (elastic#79127) Remove stale AwaitsFix in InternalEngineTests (elastic#79323) Fix errors in RefreshListenersTests (elastic#79324) Reeable BwC Tests after elastic#79318 (elastic#79320) Mute BwC Tests for elastic#79318 (elastic#79319) Reenable BwC Tests after elastic#79308 (elastic#79313) Disable BwC Tests for elastic#79308 (elastic#79310) Adjust BWC for node-level field cap requests (elastic#79301) Allow total memory to be overridden (elastic#78750) Fix SnapshotBasedIndexRecoveryIT#testRecoveryIsCancelledAfterDeletingTheIndex (elastic#79269) Disable BWC tests Mute GeoIpDownloaderCliIT.testStartWithNoDatabases (elastic#79299) Add alias support to fleet search API (elastic#79285) Create a coordinating node level reader for tsdb (elastic#79197) Route documents to the correct shards in tsdb (elastic#77731) Inject migrate action regardless of allocate action (elastic#79090) Migrate to data tiers should always ensure a TIER_PREFERENCE is set (elastic#79100) Skip building of BWC distributions when building release artifacts (elastic#79180) Default ENFORCE_DEFAULT_TIER_PREFERENCE to true (elastic#79275) Deprecation of transient cluster settings (elastic#78794) ... # Conflicts: # rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/tsdb/10_settings.yml # server/src/main/java/org/elasticsearch/common/settings/IndexScopedSettings.java # server/src/main/java/org/elasticsearch/common/settings/Setting.java # server/src/main/java/org/elasticsearch/index/IndexMode.java # server/src/test/java/org/elasticsearch/index/TimeSeriesModeTests.java

Nikola Grcevski added 11 commits October 1, 2021 11:18

Migrate to persistent settings in Java tests

93bbc7b

We are deprecating transient settings, therefore this PR changes uses of transient cluster settings to persistent cluster settings.

Merge branch 'master' into tests/persistent_settigns_java_tests

9ae1004

Bring in one doc file to match test.

b9f5e5b

Merge branch 'master' into tests/persistent_settigns_java_tests

28de853

Revert back some of the tests

0d6174f

Revert back tests that test specifically for the transient settings functionality.

Improve tests to separate transient.

689e49a

Merge branch 'master' into tests/persistent_settigns_java_tests

83a308d

Fix exception label issue.

e90822a

Merge branch 'master' into tests/persistent_settigns_java_tests

9c0be28

Bring deprecation changes.

20b9931

Fix yml test

4bde0c4

grcevski marked this pull request as draft October 6, 2021 21:16

elasticsearchmachine added the v8.0.0 label Oct 6, 2021

Nikola Grcevski added 15 commits October 6, 2021 17:22

Fix unused import.

fe1d6c8

Fix few more tests.

4a2947c

Merge branch 'master' into deprecation/transient_cluster_settings

a4ba3f2

Merge branch 'master' into tests/persistent_settigns_java_tests

d169fe6

Merge master

71f1426

Revert method rename

c3a78c7

Revert docs change.

b882a10

Merge branch 'master' into tests/persistent_settigns_java_tests

b8cbc7a

Merge branch 'tests/persistent_settigns_java_tests' into deprecation/…

3bfc81b

…transient_cluster_settings

Update docs.

1950bea

Bring back true transient test.

178410c

Merge branch 'tests/persistent_settigns_java_tests' into deprecation/…

f1d96df

…transient_cluster_settings

Fix docs.

beb04d7

Fix test bwc.

a1d37f9

Merge master

2ef0432

grcevski commented Oct 13, 2021

View reviewed changes

Fix test warning.

ab6d4dd

Nikola Grcevski added 5 commits October 14, 2021 13:26

Warn in all cases, empty or not.

b7a1e50

Revert deprecated wording.

cf3a45f

Fix tests

e301d8e

Merge branch 'master' into deprecation/transient_cluster_settings

d6464cb

More test fixes.

59a860e

sethmlarson added the Team:Clients Meta label for clients team label Oct 14, 2021

Bring back check for empty map.

6c31661

rjernst approved these changes Oct 14, 2021

View reviewed changes

Nikola Grcevski added 4 commits October 15, 2021 10:15

Use active language in deprecation message.

1e6401a

Merge branch 'master' into deprecation/transient_cluster_settings

65b3667

Fix compile issue.

a79c72b

More language changes.

4330386

Merge branch 'master' into deprecation/transient_cluster_settings

e7431ab

grcevski merged commit 055c770 into elastic:master Oct 15, 2021

grcevski deleted the deprecation/transient_cluster_settings branch October 15, 2021 17:01

grcevski mentioned this pull request Oct 15, 2021

[7.x] Deprecation of transient cluster settings (#78794) #79288

Merged

jakelandis added v8.0.0-beta1 and removed v8.0.0 labels Oct 27, 2021

jakelandis mentioned this pull request Oct 27, 2021

Tweak deprecation messaging for deprecated transient settings. #79953

Closed

pebrc mentioned this pull request Oct 28, 2021

Stop using transient settings as of 7.16 elastic/cloud-on-k8s#4997

Closed

jakelandis mentioned this pull request Oct 28, 2021

Transient settings migration documentation #80055

Closed

grcevski mentioned this pull request Nov 1, 2021

Update transient settings deprecation message #80157

Closed

jakelandis mentioned this pull request Nov 9, 2021

Revert deprecated transient settings #80556

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecation of transient cluster settings #78794

Deprecation of transient cluster settings #78794

grcevski commented Oct 6, 2021 •

edited

Loading

grcevski Oct 13, 2021 •

edited

Loading

elasticmachine commented Oct 14, 2021

grcevski commented Oct 14, 2021

rjernst left a comment

rjernst Oct 14, 2021

grcevski Oct 15, 2021

rjernst Oct 14, 2021

grcevski commented Oct 15, 2021

elasticsearchmachine commented Oct 15, 2021

Deprecation of transient cluster settings #78794

Deprecation of transient cluster settings #78794

Conversation

grcevski commented Oct 6, 2021 • edited Loading

grcevski Oct 13, 2021 • edited Loading

Choose a reason for hiding this comment

elasticmachine commented Oct 14, 2021

grcevski commented Oct 14, 2021

rjernst left a comment

Choose a reason for hiding this comment

rjernst Oct 14, 2021

Choose a reason for hiding this comment

grcevski Oct 15, 2021

Choose a reason for hiding this comment

rjernst Oct 14, 2021

Choose a reason for hiding this comment

grcevski commented Oct 15, 2021

elasticsearchmachine commented Oct 15, 2021

💔 Backport failed

grcevski commented Oct 6, 2021 •

edited

Loading

grcevski Oct 13, 2021 •

edited

Loading