org.elasticsearch.action.admin.cluster.settings.TransportClusterUpdateSettingsAction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :distribution:archives:integ-test-zip
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.action.admin.cluster.settings;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.message.ParameterizedMessage;
import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.support.ActionFilters;
import org.elasticsearch.action.support.master.TransportMasterNodeAction;
import org.elasticsearch.cluster.AckedClusterStateUpdateTask;
import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.cluster.block.ClusterBlockException;
import org.elasticsearch.cluster.block.ClusterBlockLevel;
import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver;
import org.elasticsearch.cluster.metadata.Metadata;
import org.elasticsearch.cluster.node.DiscoveryNode;
import org.elasticsearch.cluster.routing.allocation.AllocationService;
import org.elasticsearch.cluster.service.ClusterService;
import org.elasticsearch.common.Priority;
import org.elasticsearch.common.inject.Inject;
import org.elasticsearch.common.settings.ClusterSettings;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.core.Nullable;
import org.elasticsearch.threadpool.ThreadPool;
import org.elasticsearch.transport.TransportService;
import java.util.HashSet;
import java.util.Set;
import static org.elasticsearch.common.settings.AbstractScopedSettings.ARCHIVED_SETTINGS_PREFIX;
public class TransportClusterUpdateSettingsAction extends TransportMasterNodeAction<
ClusterUpdateSettingsRequest,
ClusterUpdateSettingsResponse> {
private static final Logger logger = LogManager.getLogger(TransportClusterUpdateSettingsAction.class);
private final AllocationService allocationService;
private final ClusterSettings clusterSettings;
@Inject
public TransportClusterUpdateSettingsAction(
TransportService transportService,
ClusterService clusterService,
ThreadPool threadPool,
AllocationService allocationService,
ActionFilters actionFilters,
IndexNameExpressionResolver indexNameExpressionResolver,
ClusterSettings clusterSettings
) {
super(
ClusterUpdateSettingsAction.NAME,
false,
transportService,
clusterService,
threadPool,
actionFilters,
ClusterUpdateSettingsRequest::new,
indexNameExpressionResolver,
ClusterUpdateSettingsResponse::new,
ThreadPool.Names.SAME
);
this.allocationService = allocationService;
this.clusterSettings = clusterSettings;
}
/**
skip check block if:
* Only at least one of cluster.blocks.read_only or cluster.blocks.read_only_allow_delete is being cleared (set to null or false).
* Or all of the following are true:
* 1. At least one of cluster.blocks.read_only or cluster.blocks.read_only_allow_delete is being cleared (set to null or false).
* 2. Neither cluster.blocks.read_only nor cluster.blocks.read_only_allow_delete is being set to true.
* 3. The only other settings in this update are archived ones being set to null.
*/
@Override
protected ClusterBlockException checkBlock(ClusterUpdateSettingsRequest request, ClusterState state) {
Set clearedBlockAndArchivedSettings = new HashSet<>();
if (checkClearedBlockAndArchivedSettings(request.transientSettings(), clearedBlockAndArchivedSettings)
&& checkClearedBlockAndArchivedSettings(request.persistentSettings(), clearedBlockAndArchivedSettings)) {
if (clearedBlockAndArchivedSettings.contains(Metadata.SETTING_READ_ONLY_SETTING.getKey())
|| clearedBlockAndArchivedSettings.contains(Metadata.SETTING_READ_ONLY_ALLOW_DELETE_SETTING.getKey())) {
return null;
}
}
return state.blocks().globalBlockedException(ClusterBlockLevel.METADATA_WRITE);
}
/**
* Check settings that only contains block and archived settings.
* @param settings target settings to be checked.
* @param clearedBlockAndArchivedSettings block settings that have been set to null or false,
* archived settings that have been set to null.
* @return true if all settings are clear blocks or archived settings.
*/
private boolean checkClearedBlockAndArchivedSettings(final Settings settings, final Set clearedBlockAndArchivedSettings) {
for (String key : settings.keySet()) {
if (Metadata.SETTING_READ_ONLY_SETTING.getKey().equals(key)) {
if (Metadata.SETTING_READ_ONLY_SETTING.get(settings)) {
// set block as true
return false;
}
} else if (Metadata.SETTING_READ_ONLY_ALLOW_DELETE_SETTING.getKey().equals(key)) {
if (Metadata.SETTING_READ_ONLY_ALLOW_DELETE_SETTING.get(settings)) {
// set block as true
return false;
}
} else if (key.startsWith(ARCHIVED_SETTINGS_PREFIX)) {
if (settings.get(key) != null) {
// archived setting value is not null
return false;
}
} else {
// other settings
return false;
}
clearedBlockAndArchivedSettings.add(key);
}
return true;
}
@Override
protected void masterOperation(
final ClusterUpdateSettingsRequest request,
final ClusterState state,
final ActionListener listener
) {
final SettingsUpdater updater = new SettingsUpdater(clusterSettings);
clusterService.submitStateUpdateTask(
"cluster_update_settings",
new AckedClusterStateUpdateTask(Priority.IMMEDIATE, request, listener) {
private volatile boolean changed = false;
@Override
protected ClusterUpdateSettingsResponse newResponse(boolean acknowledged) {
return new ClusterUpdateSettingsResponse(acknowledged, updater.getTransientUpdates(), updater.getPersistentUpdate());
}
@Override
public void onAllNodesAcked(@Nullable Exception e) {
if (changed) {
reroute(true);
} else {
super.onAllNodesAcked(e);
}
}
@Override
public void onAckTimeout() {
if (changed) {
reroute(false);
} else {
super.onAckTimeout();
}
}
private void reroute(final boolean updateSettingsAcked) {
// We're about to send a second update task, so we need to check if we're still the elected master
// For example the minimum_master_node could have been breached and we're no longer elected master,
// so we should *not* execute the reroute.
if (clusterService.state().nodes().isLocalNodeElectedMaster() == false) {
logger.debug("Skipping reroute after cluster update settings, because node is no longer master");
listener.onResponse(
new ClusterUpdateSettingsResponse(
updateSettingsAcked,
updater.getTransientUpdates(),
updater.getPersistentUpdate()
)
);
return;
}
// The reason the reroute needs to be send as separate update task, is that all the *cluster* settings are encapsulate
// in the components (e.g. FilterAllocationDecider), so the changes made by the first call aren't visible
// to the components until the ClusterStateListener instances have been invoked, but are visible after
// the first update task has been completed.
clusterService.submitStateUpdateTask(
"reroute_after_cluster_update_settings",
new AckedClusterStateUpdateTask(Priority.URGENT, request, listener) {
@Override
public boolean mustAck(DiscoveryNode discoveryNode) {
// we wait for the reroute ack only if the update settings was acknowledged
return updateSettingsAcked;
}
@Override
// we return when the cluster reroute is acked or it times out but the acknowledged flag depends on whether the
// update settings was acknowledged
protected ClusterUpdateSettingsResponse newResponse(boolean acknowledged) {
return new ClusterUpdateSettingsResponse(
updateSettingsAcked && acknowledged,
updater.getTransientUpdates(),
updater.getPersistentUpdate()
);
}
@Override
public void onNoLongerMaster(String source) {
logger.debug(
"failed to preform reroute after cluster settings were updated - current node is no longer a master"
);
listener.onResponse(
new ClusterUpdateSettingsResponse(
updateSettingsAcked,
updater.getTransientUpdates(),
updater.getPersistentUpdate()
)
);
}
@Override
public void onFailure(String source, Exception e) {
// if the reroute fails we only log
logger.debug(() -> new ParameterizedMessage("failed to perform [{}]", source), e);
listener.onFailure(new ElasticsearchException("reroute after update settings failed", e));
}
@Override
public ClusterState execute(final ClusterState currentState) {
// now, reroute in case things that require it changed (e.g. number of replicas)
return allocationService.reroute(currentState, "reroute after cluster update settings");
}
}
);
}
@Override
public void onFailure(String source, Exception e) {
logger.debug(() -> new ParameterizedMessage("failed to perform [{}]", source), e);
super.onFailure(source, e);
}
@Override
public ClusterState execute(final ClusterState currentState) {
final ClusterState clusterState = updater.updateSettings(
currentState,
clusterSettings.upgradeSettings(request.transientSettings()),
clusterSettings.upgradeSettings(request.persistentSettings()),
logger
);
changed = clusterState != currentState;
return clusterState;
}
}
);
}
}