From 22542df9d2a5089f9593af562297ec9ed65b9fcc Mon Sep 17 00:00:00 2001 From: Jason Tedor Date: Sat, 24 Aug 2019 09:18:48 -0400 Subject: [PATCH 1/2] Remove the pidfile setting The pidfile setting was deprecated in version 7.4.0 of Elasticsearch for removal in Elasticsearch 8.0.0. This commit removes the pidfile setting. --- .../migration/migrate_8_0/settings.asciidoc | 8 ++++++++ .../common/settings/ClusterSettings.java | 1 - .../java/org/elasticsearch/env/Environment.java | 8 ++------ .../org/elasticsearch/env/EnvironmentTests.java | 15 ++------------- 4 files changed, 12 insertions(+), 20 deletions(-) diff --git a/docs/reference/migration/migrate_8_0/settings.asciidoc b/docs/reference/migration/migrate_8_0/settings.asciidoc index 11eb42b6290df..82ef5b8190adf 100644 --- a/docs/reference/migration/migrate_8_0/settings.asciidoc +++ b/docs/reference/migration/migrate_8_0/settings.asciidoc @@ -12,6 +12,14 @@ counterparts. In 8.0.0, these settings have been removed. Elasticsearch will refuse to start if you have these settings in your configuration or cluster state. +[float] +[[remove-pidfile]] +==== `pidfile` setting is replaced by `node.pidfile` + +To ensure that all settings are in a proper namespace, the `pidfile` setting was +previously deprecated in version 7.4.0 of Elasticsearch, and is removed in +version 8.0.0. Instead, use `node.pidfile`. + [float] [[remove-processors]] ==== `processors` setting is replaced by `node.processors` diff --git a/server/src/main/java/org/elasticsearch/common/settings/ClusterSettings.java b/server/src/main/java/org/elasticsearch/common/settings/ClusterSettings.java index 05a7aae14b5cd..92332225ed5c8 100644 --- a/server/src/main/java/org/elasticsearch/common/settings/ClusterSettings.java +++ b/server/src/main/java/org/elasticsearch/common/settings/ClusterSettings.java @@ -362,7 +362,6 @@ public void apply(Settings value, Settings current, Settings previous) { Environment.PATH_LOGS_SETTING, Environment.PATH_REPO_SETTING, Environment.PATH_SHARED_DATA_SETTING, - Environment.PIDFILE_SETTING, Environment.NODE_PIDFILE_SETTING, NodeEnvironment.NODE_ID_SEED_SETTING, Node.INITIAL_STATE_TIMEOUT_SETTING, diff --git a/server/src/main/java/org/elasticsearch/env/Environment.java b/server/src/main/java/org/elasticsearch/env/Environment.java index 261406db2f7e8..4455d8401f5c6 100644 --- a/server/src/main/java/org/elasticsearch/env/Environment.java +++ b/server/src/main/java/org/elasticsearch/env/Environment.java @@ -60,8 +60,7 @@ public class Environment { public static final Setting> PATH_REPO_SETTING = Setting.listSetting("path.repo", Collections.emptyList(), Function.identity(), Property.NodeScope); public static final Setting PATH_SHARED_DATA_SETTING = Setting.simpleString("path.shared_data", Property.NodeScope); - public static final Setting PIDFILE_SETTING = Setting.simpleString("pidfile", Property.Deprecated, Property.NodeScope); - public static final Setting NODE_PIDFILE_SETTING = Setting.simpleString("node.pidfile", PIDFILE_SETTING, Property.NodeScope); + public static final Setting NODE_PIDFILE_SETTING = Setting.simpleString("node.pidfile", Property.NodeScope); private final Settings settings; @@ -155,7 +154,7 @@ public Environment(final Settings settings, final Path configPath) { logsFile = homeFile.resolve("logs"); } - if (NODE_PIDFILE_SETTING.exists(settings) || PIDFILE_SETTING.exists(settings)) { + if (NODE_PIDFILE_SETTING.exists(settings)) { pidFile = PathUtils.get(NODE_PIDFILE_SETTING.get(settings)).toAbsolutePath().normalize(); } else { pidFile = null; @@ -183,9 +182,6 @@ public Environment(final Settings settings, final Path configPath) { if (NODE_PIDFILE_SETTING.exists(settings)) { assert pidFile != null; finalSettings.put(Environment.NODE_PIDFILE_SETTING.getKey(), pidFile.toString()); - } else if (PIDFILE_SETTING.exists(settings)) { - assert pidFile != null; - finalSettings.put(Environment.PIDFILE_SETTING.getKey(), pidFile.toString()); } this.settings = finalSettings.build(); } diff --git a/server/src/test/java/org/elasticsearch/env/EnvironmentTests.java b/server/src/test/java/org/elasticsearch/env/EnvironmentTests.java index ee9fc0b694ed6..862f2cb99a7d2 100644 --- a/server/src/test/java/org/elasticsearch/env/EnvironmentTests.java +++ b/server/src/test/java/org/elasticsearch/env/EnvironmentTests.java @@ -175,20 +175,13 @@ public void testTempPathValidationWhenRegularFile() throws IOException { // test that environment paths are absolute and normalized public void testPathNormalization() throws IOException { - final Setting pidFileSetting; - if (randomBoolean()) { - pidFileSetting = Environment.NODE_PIDFILE_SETTING; - } else { - pidFileSetting = Environment.PIDFILE_SETTING; - } - final Settings settings = Settings.builder() .put(Environment.PATH_HOME_SETTING.getKey(), "home") .put(Environment.PATH_DATA_SETTING.getKey(), "./home/../home/data") .put(Environment.PATH_LOGS_SETTING.getKey(), "./home/../home/logs") .put(Environment.PATH_REPO_SETTING.getKey(), "./home/../home/repo") .put(Environment.PATH_SHARED_DATA_SETTING.getKey(), "./home/../home/shared_data") - .put(pidFileSetting.getKey(), "./home/../home/pidfile") + .put(Environment.NODE_PIDFILE_SETTING.getKey(), "./home/../home/pidfile") .build(); // the above paths will be treated as relative to the working directory @@ -214,12 +207,8 @@ public void testPathNormalization() throws IOException { final String sharedDataPath = Environment.PATH_SHARED_DATA_SETTING.get(environment.settings()); assertPath(sharedDataPath, home.resolve("shared_data")); - final String pidFile = pidFileSetting.get(environment.settings()); + final String pidFile = Environment.NODE_PIDFILE_SETTING.get(environment.settings()); assertPath(pidFile, home.resolve("pidfile")); - - if (pidFileSetting.isDeprecated()) { - assertSettingDeprecationsAndWarnings(new Setting[] { pidFileSetting }); - } } private void assertPath(final String actual, final Path expected) { From 810cb315d2c529db365ffc3778da8ff7143331e7 Mon Sep 17 00:00:00 2001 From: Jason Tedor Date: Sat, 24 Aug 2019 09:36:07 -0400 Subject: [PATCH 2/2] Fix imports --- server/src/test/java/org/elasticsearch/env/EnvironmentTests.java | 1 - 1 file changed, 1 deletion(-) diff --git a/server/src/test/java/org/elasticsearch/env/EnvironmentTests.java b/server/src/test/java/org/elasticsearch/env/EnvironmentTests.java index 862f2cb99a7d2..5754067d72bf9 100644 --- a/server/src/test/java/org/elasticsearch/env/EnvironmentTests.java +++ b/server/src/test/java/org/elasticsearch/env/EnvironmentTests.java @@ -19,7 +19,6 @@ package org.elasticsearch.env; import org.elasticsearch.common.io.PathUtils; -import org.elasticsearch.common.settings.Setting; import org.elasticsearch.common.settings.Settings; import org.elasticsearch.test.ESTestCase;