org.opensearch.index.remote.RemoteMigrationIndexMetadataUpdater Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation
Show all versions of opensearch Show documentation
OpenSearch subproject :server
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
package org.opensearch.index.remote;
import org.apache.logging.log4j.Logger;
import org.opensearch.cluster.metadata.IndexMetadata;
import org.opensearch.cluster.node.DiscoveryNodes;
import org.opensearch.cluster.routing.IndexRoutingTable;
import org.opensearch.cluster.routing.RoutingTable;
import org.opensearch.cluster.routing.ShardRouting;
import org.opensearch.cluster.routing.ShardRoutingState;
import org.opensearch.common.settings.Settings;
import org.opensearch.index.remote.RemoteStoreEnums.PathType;
import org.opensearch.indices.replication.common.ReplicationType;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import static org.opensearch.cluster.metadata.IndexMetadata.REMOTE_STORE_CUSTOM_KEY;
import static org.opensearch.cluster.metadata.IndexMetadata.SETTING_REMOTE_SEGMENT_STORE_REPOSITORY;
import static org.opensearch.cluster.metadata.IndexMetadata.SETTING_REMOTE_STORE_ENABLED;
import static org.opensearch.cluster.metadata.IndexMetadata.SETTING_REMOTE_TRANSLOG_STORE_REPOSITORY;
import static org.opensearch.cluster.metadata.IndexMetadata.SETTING_REPLICATION_TYPE;
import static org.opensearch.index.remote.RemoteStoreUtils.determineRemoteStoreCustomMetadataDuringMigration;
import static org.opensearch.index.remote.RemoteStoreUtils.getRemoteStoreRepoName;
import static org.opensearch.node.remotestore.RemoteStoreNodeAttribute.REMOTE_STORE_SEGMENT_REPOSITORY_NAME_ATTRIBUTE_KEY;
import static org.opensearch.node.remotestore.RemoteStoreNodeAttribute.REMOTE_STORE_TRANSLOG_REPOSITORY_NAME_ATTRIBUTE_KEY;
/**
* Utils for checking and mutating cluster state during remote migration
*
* @opensearch.internal
*/
public class RemoteMigrationIndexMetadataUpdater {
private final DiscoveryNodes discoveryNodes;
private final RoutingTable routingTable;
private final Settings clusterSettings;
private final IndexMetadata indexMetadata;
private final Logger logger;
public RemoteMigrationIndexMetadataUpdater(
DiscoveryNodes discoveryNodes,
RoutingTable routingTable,
IndexMetadata indexMetadata,
Settings clusterSettings,
Logger logger
) {
this.discoveryNodes = discoveryNodes;
this.routingTable = routingTable;
this.clusterSettings = clusterSettings;
this.indexMetadata = indexMetadata;
this.logger = logger;
}
/**
* During docrep to remote store migration, applies the following remote store based index settings
* once all shards of an index have moved over to remote store enabled nodes
*
* Also appends the requisite Remote Store Path based custom metadata to the existing index metadata
*/
public void maybeAddRemoteIndexSettings(IndexMetadata.Builder indexMetadataBuilder, String index) {
Settings currentIndexSettings = indexMetadata.getSettings();
if (needsRemoteIndexSettingsUpdate(routingTable.indicesRouting().get(index), discoveryNodes, currentIndexSettings)) {
logger.info(
"Index {} does not have remote store based index settings but all primary shards and STARTED replica shards have moved to remote enabled nodes. Applying remote store settings to the index",
index
);
Map remoteRepoNames = getRemoteStoreRepoName(discoveryNodes);
String segmentRepoName = remoteRepoNames.get(REMOTE_STORE_SEGMENT_REPOSITORY_NAME_ATTRIBUTE_KEY);
String tlogRepoName = remoteRepoNames.get(REMOTE_STORE_TRANSLOG_REPOSITORY_NAME_ATTRIBUTE_KEY);
assert Objects.nonNull(segmentRepoName) && Objects.nonNull(tlogRepoName) : "Remote repo names cannot be null";
Settings.Builder indexSettingsBuilder = Settings.builder().put(currentIndexSettings);
updateRemoteStoreSettings(indexSettingsBuilder, segmentRepoName, tlogRepoName);
indexMetadataBuilder.settings(indexSettingsBuilder);
indexMetadataBuilder.settingsVersion(1 + indexMetadata.getVersion());
} else {
logger.debug("Index {} does not satisfy criteria for applying remote store settings", index);
}
}
/**
* Returns true iff all the below conditions are true:
* - All primary shards are in {@link ShardRoutingState#STARTED} state and are in remote store enabled nodes
* - No replica shard in {@link ShardRoutingState#RELOCATING} state
* - All {@link ShardRoutingState#STARTED} replica shards are in remote store enabled nodes
*
* @param indexRoutingTable current {@link IndexRoutingTable} from cluster state
* @param discoveryNodes set of discovery nodes from cluster state
* @param currentIndexSettings current {@link IndexMetadata} from cluster state
* @return true or false depending on the met conditions
*/
private boolean needsRemoteIndexSettingsUpdate(
IndexRoutingTable indexRoutingTable,
DiscoveryNodes discoveryNodes,
Settings currentIndexSettings
) {
assert currentIndexSettings != null : "IndexMetadata for a shard cannot be null";
if (indexHasRemoteStoreSettings(currentIndexSettings) == false) {
boolean allPrimariesStartedAndOnRemote = indexRoutingTable.shardsMatchingPredicate(ShardRouting::primary)
.stream()
.allMatch(shardRouting -> shardRouting.started() && discoveryNodes.get(shardRouting.currentNodeId()).isRemoteStoreNode());
List replicaShards = indexRoutingTable.shardsMatchingPredicate(shardRouting -> shardRouting.primary() == false);
boolean noRelocatingReplicas = replicaShards.stream().noneMatch(ShardRouting::relocating);
boolean allStartedReplicasOnRemote = replicaShards.stream()
.filter(ShardRouting::started)
.allMatch(shardRouting -> discoveryNodes.get(shardRouting.currentNodeId()).isRemoteStoreNode());
return allPrimariesStartedAndOnRemote && noRelocatingReplicas && allStartedReplicasOnRemote;
}
return false;
}
/**
* Updates the remote store custom metadata for the index when it is migrating to remote.
* This is run during state change of each shard copy when the cluster is in `MIXED` mode and the direction of migration is `REMOTE_STORE`
* Should not interfere with docrep functionality even if the index is in docrep nodes since this metadata
* is not used anywhere in the docrep flow
* Checks are in place to make this execution no-op if the index metadata is already present.
*
* @param indexMetadataBuilder Mutated {@link IndexMetadata.Builder} having the previous state updates
* @param index index name
*/
public void maybeUpdateRemoteStoreCustomMetadata(IndexMetadata.Builder indexMetadataBuilder, String index) {
if (indexHasRemoteCustomMetadata(indexMetadata) == false) {
logger.info("Adding remote store custom data for index [{}] during migration", index);
indexMetadataBuilder.putCustom(
REMOTE_STORE_CUSTOM_KEY,
determineRemoteStoreCustomMetadataDuringMigration(clusterSettings, discoveryNodes)
);
} else {
logger.debug("Index {} already has remote store custom data", index);
}
}
public static boolean indexHasAllRemoteStoreRelatedMetadata(IndexMetadata indexMetadata) {
return indexHasRemoteStoreSettings(indexMetadata.getSettings()) && indexHasRemoteCustomMetadata(indexMetadata);
}
/**
* Assert current index settings have:
* - index.remote_store.enabled == true
* - index.remote_store.segment.repository != null
* - index.remote_store.translog.repository != null
* - index.replication.type == SEGMENT
*
* @param indexSettings Current index settings
* @return true if all above conditions match. false otherwise
*/
public static boolean indexHasRemoteStoreSettings(Settings indexSettings) {
return IndexMetadata.INDEX_REMOTE_STORE_ENABLED_SETTING.exists(indexSettings)
&& IndexMetadata.INDEX_REMOTE_TRANSLOG_REPOSITORY_SETTING.exists(indexSettings)
&& IndexMetadata.INDEX_REMOTE_SEGMENT_STORE_REPOSITORY_SETTING.exists(indexSettings)
&& IndexMetadata.INDEX_REPLICATION_TYPE_SETTING.get(indexSettings) == ReplicationType.SEGMENT;
}
/**
* Asserts current index metadata customs has the {@link IndexMetadata#REMOTE_STORE_CUSTOM_KEY} key.
* If it does, checks if the path_type sub-key is present
*
* @param indexMetadata Current index metadata
* @return true if all above conditions match. false otherwise
*/
public static boolean indexHasRemoteCustomMetadata(IndexMetadata indexMetadata) {
Map customMetadata = indexMetadata.getCustomData(REMOTE_STORE_CUSTOM_KEY);
return Objects.nonNull(customMetadata)
&& (Objects.nonNull(customMetadata.get(PathType.NAME))
|| Objects.nonNull(customMetadata.get(IndexMetadata.TRANSLOG_METADATA_KEY)));
}
public static void updateRemoteStoreSettings(Settings.Builder settingsBuilder, String segmentRepository, String translogRepository) {
settingsBuilder.put(SETTING_REMOTE_STORE_ENABLED, true)
.put(SETTING_REPLICATION_TYPE, ReplicationType.SEGMENT)
.put(SETTING_REMOTE_SEGMENT_STORE_REPOSITORY, segmentRepository)
.put(SETTING_REMOTE_TRANSLOG_STORE_REPOSITORY, translogRepository);
}
}