-
Notifications
You must be signed in to change notification settings - Fork 24.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove persistent cluster settings tool (#50694)
Adds the elasticsearch-node remove-settings tool to remove persistent settings from the on disk cluster state in case where it contains incompatible settings that prevent the cluster from forming. Relates #48701
- Loading branch information
Showing
5 changed files
with
311 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
104 changes: 104 additions & 0 deletions
104
server/src/main/java/org/elasticsearch/cluster/coordination/RemoveSettingsCommand.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
package org.elasticsearch.cluster.coordination; | ||
|
||
import joptsimple.OptionSet; | ||
import joptsimple.OptionSpec; | ||
import org.elasticsearch.cli.ExitCodes; | ||
import org.elasticsearch.cli.Terminal; | ||
import org.elasticsearch.cli.UserException; | ||
import org.elasticsearch.cluster.ClusterState; | ||
import org.elasticsearch.cluster.metadata.MetaData; | ||
import org.elasticsearch.common.collect.Tuple; | ||
import org.elasticsearch.common.regex.Regex; | ||
import org.elasticsearch.common.settings.Settings; | ||
import org.elasticsearch.env.Environment; | ||
import org.elasticsearch.gateway.PersistedClusterStateService; | ||
|
||
import java.io.IOException; | ||
import java.nio.file.Path; | ||
import java.util.List; | ||
|
||
public class RemoveSettingsCommand extends ElasticsearchNodeCommand { | ||
|
||
static final String SETTINGS_REMOVED_MSG = "Settings were successfully removed from the cluster state"; | ||
static final String CONFIRMATION_MSG = | ||
DELIMITER + | ||
"\n" + | ||
"You should only run this tool if you have incompatible settings in the\n" + | ||
"cluster state that prevent the cluster from forming.\n" + | ||
"This tool can cause data loss and its use should be your last resort.\n" + | ||
"\n" + | ||
"Do you want to proceed?\n"; | ||
|
||
private final OptionSpec<String> arguments; | ||
|
||
public RemoveSettingsCommand() { | ||
super("Removes persistent settings from the cluster state"); | ||
arguments = parser.nonOptions("setting names"); | ||
} | ||
|
||
@Override | ||
protected void processNodePaths(Terminal terminal, Path[] dataPaths, OptionSet options, Environment env) | ||
throws IOException, UserException { | ||
final List<String> settingsToRemove = arguments.values(options); | ||
if (settingsToRemove.isEmpty()) { | ||
throw new UserException(ExitCodes.USAGE, "Must supply at least one setting to remove"); | ||
} | ||
|
||
final PersistedClusterStateService persistedClusterStateService = createPersistedClusterStateService(dataPaths); | ||
|
||
terminal.println(Terminal.Verbosity.VERBOSE, "Loading cluster state"); | ||
final Tuple<Long, ClusterState> termAndClusterState = loadTermAndClusterState(persistedClusterStateService, env); | ||
final ClusterState oldClusterState = termAndClusterState.v2(); | ||
final Settings oldPersistentSettings = oldClusterState.metaData().persistentSettings(); | ||
terminal.println(Terminal.Verbosity.VERBOSE, "persistent settings: " + oldPersistentSettings); | ||
final Settings.Builder newPersistentSettingsBuilder = Settings.builder().put(oldPersistentSettings); | ||
for (String settingToRemove : settingsToRemove) { | ||
boolean matched = false; | ||
for (String settingKey : oldPersistentSettings.keySet()) { | ||
if (Regex.simpleMatch(settingToRemove, settingKey)) { | ||
newPersistentSettingsBuilder.remove(settingKey); | ||
if (matched == false) { | ||
terminal.println("The following settings will be removed:"); | ||
} | ||
matched = true; | ||
terminal.println(settingKey + ": " + oldPersistentSettings.get(settingKey)); | ||
} | ||
} | ||
if (matched == false) { | ||
throw new UserException(ExitCodes.USAGE, | ||
"No persistent cluster settings matching [" + settingToRemove + "] were found on this node"); | ||
} | ||
} | ||
final ClusterState newClusterState = ClusterState.builder(oldClusterState) | ||
.metaData(MetaData.builder(oldClusterState.metaData()).persistentSettings(newPersistentSettingsBuilder.build()).build()) | ||
.build(); | ||
terminal.println(Terminal.Verbosity.VERBOSE, | ||
"[old cluster state = " + oldClusterState + ", new cluster state = " + newClusterState + "]"); | ||
|
||
confirm(terminal, CONFIRMATION_MSG); | ||
|
||
try (PersistedClusterStateService.Writer writer = persistedClusterStateService.createWriter()) { | ||
writer.writeFullStateAndCommit(termAndClusterState.v1(), newClusterState); | ||
} | ||
|
||
terminal.println(SETTINGS_REMOVED_MSG); | ||
} | ||
} |
135 changes: 135 additions & 0 deletions
135
server/src/test/java/org/elasticsearch/cluster/coordination/RemoveSettingsCommandIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,135 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
package org.elasticsearch.cluster.coordination; | ||
|
||
import joptsimple.OptionSet; | ||
import org.elasticsearch.ElasticsearchException; | ||
import org.elasticsearch.cli.MockTerminal; | ||
import org.elasticsearch.cli.UserException; | ||
import org.elasticsearch.cluster.routing.allocation.DiskThresholdSettings; | ||
import org.elasticsearch.common.settings.Settings; | ||
import org.elasticsearch.env.Environment; | ||
import org.elasticsearch.env.TestEnvironment; | ||
import org.elasticsearch.test.ESIntegTestCase; | ||
|
||
import static org.hamcrest.Matchers.contains; | ||
import static org.hamcrest.Matchers.containsString; | ||
import static org.hamcrest.Matchers.not; | ||
|
||
@ESIntegTestCase.ClusterScope(scope = ESIntegTestCase.Scope.TEST, numDataNodes = 0, autoManageMasterNodes = false) | ||
public class RemoveSettingsCommandIT extends ESIntegTestCase { | ||
|
||
public void testRemoveSettingsAbortedByUser() throws Exception { | ||
internalCluster().setBootstrapMasterNodeIndex(0); | ||
String node = internalCluster().startNode(); | ||
client().admin().cluster().prepareUpdateSettings().setPersistentSettings(Settings.builder() | ||
.put(DiskThresholdSettings.CLUSTER_ROUTING_ALLOCATION_DISK_THRESHOLD_ENABLED_SETTING.getKey(), false).build()).get(); | ||
Settings dataPathSettings = internalCluster().dataPathSettings(node); | ||
ensureStableCluster(1); | ||
internalCluster().stopRandomDataNode(); | ||
|
||
Environment environment = TestEnvironment.newEnvironment( | ||
Settings.builder().put(internalCluster().getDefaultSettings()).put(dataPathSettings).build()); | ||
expectThrows(() -> removeSettings(environment, true, | ||
new String[]{ DiskThresholdSettings.CLUSTER_ROUTING_ALLOCATION_DISK_THRESHOLD_ENABLED_SETTING.getKey() }), | ||
ElasticsearchNodeCommand.ABORTED_BY_USER_MSG); | ||
} | ||
|
||
public void testRemoveSettingsSuccessful() throws Exception { | ||
internalCluster().setBootstrapMasterNodeIndex(0); | ||
String node = internalCluster().startNode(); | ||
client().admin().cluster().prepareUpdateSettings().setPersistentSettings(Settings.builder() | ||
.put(DiskThresholdSettings.CLUSTER_ROUTING_ALLOCATION_DISK_THRESHOLD_ENABLED_SETTING.getKey(), false).build()).get(); | ||
assertThat(client().admin().cluster().prepareState().get().getState().metaData().persistentSettings().keySet(), | ||
contains(DiskThresholdSettings.CLUSTER_ROUTING_ALLOCATION_DISK_THRESHOLD_ENABLED_SETTING.getKey())); | ||
Settings dataPathSettings = internalCluster().dataPathSettings(node); | ||
ensureStableCluster(1); | ||
internalCluster().stopRandomDataNode(); | ||
|
||
Environment environment = TestEnvironment.newEnvironment( | ||
Settings.builder().put(internalCluster().getDefaultSettings()).put(dataPathSettings).build()); | ||
MockTerminal terminal = removeSettings(environment, false, | ||
randomBoolean() ? | ||
new String[]{ DiskThresholdSettings.CLUSTER_ROUTING_ALLOCATION_DISK_THRESHOLD_ENABLED_SETTING.getKey() } : | ||
new String[]{ "cluster.routing.allocation.disk.*" } | ||
); | ||
assertThat(terminal.getOutput(), containsString(RemoveSettingsCommand.SETTINGS_REMOVED_MSG)); | ||
assertThat(terminal.getOutput(), containsString("The following settings will be removed:")); | ||
assertThat(terminal.getOutput(), containsString( | ||
DiskThresholdSettings.CLUSTER_ROUTING_ALLOCATION_DISK_THRESHOLD_ENABLED_SETTING.getKey() + ": " + false)); | ||
|
||
internalCluster().startNode(dataPathSettings); | ||
assertThat(client().admin().cluster().prepareState().get().getState().metaData().persistentSettings().keySet(), | ||
not(contains(DiskThresholdSettings.CLUSTER_ROUTING_ALLOCATION_DISK_THRESHOLD_ENABLED_SETTING.getKey()))); | ||
} | ||
|
||
public void testSettingDoesNotMatch() throws Exception { | ||
internalCluster().setBootstrapMasterNodeIndex(0); | ||
String node = internalCluster().startNode(); | ||
client().admin().cluster().prepareUpdateSettings().setPersistentSettings(Settings.builder() | ||
.put(DiskThresholdSettings.CLUSTER_ROUTING_ALLOCATION_DISK_THRESHOLD_ENABLED_SETTING.getKey(), false).build()).get(); | ||
assertThat(client().admin().cluster().prepareState().get().getState().metaData().persistentSettings().keySet(), | ||
contains(DiskThresholdSettings.CLUSTER_ROUTING_ALLOCATION_DISK_THRESHOLD_ENABLED_SETTING.getKey())); | ||
Settings dataPathSettings = internalCluster().dataPathSettings(node); | ||
ensureStableCluster(1); | ||
internalCluster().stopRandomDataNode(); | ||
|
||
Environment environment = TestEnvironment.newEnvironment( | ||
Settings.builder().put(internalCluster().getDefaultSettings()).put(dataPathSettings).build()); | ||
UserException ex = expectThrows(UserException.class, () -> removeSettings(environment, false, | ||
new String[]{ "cluster.routing.allocation.disk.bla.*" })); | ||
assertThat(ex.getMessage(), containsString("No persistent cluster settings matching [cluster.routing.allocation.disk.bla.*] were " + | ||
"found on this node")); | ||
} | ||
|
||
private MockTerminal executeCommand(ElasticsearchNodeCommand command, Environment environment, boolean abort, String... args) | ||
throws Exception { | ||
final MockTerminal terminal = new MockTerminal(); | ||
final OptionSet options = command.getParser().parse(args); | ||
final String input; | ||
|
||
if (abort) { | ||
input = randomValueOtherThanMany(c -> c.equalsIgnoreCase("y"), () -> randomAlphaOfLength(1)); | ||
} else { | ||
input = randomBoolean() ? "y" : "Y"; | ||
} | ||
|
||
terminal.addTextInput(input); | ||
|
||
try { | ||
command.execute(terminal, options, environment); | ||
} finally { | ||
assertThat(terminal.getOutput(), containsString(ElasticsearchNodeCommand.STOP_WARNING_MSG)); | ||
} | ||
|
||
return terminal; | ||
} | ||
|
||
private MockTerminal removeSettings(Environment environment, boolean abort, String... args) throws Exception { | ||
final MockTerminal terminal = executeCommand(new RemoveSettingsCommand(), environment, abort, args); | ||
assertThat(terminal.getOutput(), containsString(RemoveSettingsCommand.CONFIRMATION_MSG)); | ||
assertThat(terminal.getOutput(), containsString(RemoveSettingsCommand.SETTINGS_REMOVED_MSG)); | ||
return terminal; | ||
} | ||
|
||
private void expectThrows(ThrowingRunnable runnable, String message) { | ||
ElasticsearchException ex = expectThrows(ElasticsearchException.class, runnable); | ||
assertThat(ex.getMessage(), containsString(message)); | ||
} | ||
} |