[ML] Automatically rollover legacy ml indices #120405
There are no files selected for viewing
This file contains hidden or 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,5 @@ | ||
| pr: 120405 | ||
| summary: Automatically rollover legacy ml indices | ||
| area: Machine Learning | ||
| type: upgrade | ||
| issues: [] |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,176 @@ | ||
| /* | ||
| * 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; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| package org.elasticsearch.xpack.ml; | ||
|
|
||
| import org.elasticsearch.ElasticsearchException; | ||
| import org.elasticsearch.ElasticsearchStatusException; | ||
| import org.elasticsearch.TransportVersion; | ||
| import org.elasticsearch.TransportVersions; | ||
| import org.elasticsearch.action.ActionListener; | ||
| import org.elasticsearch.action.admin.indices.rollover.RolloverRequest; | ||
| import org.elasticsearch.action.support.IndicesOptions; | ||
| import org.elasticsearch.action.support.PlainActionFuture; | ||
| import org.elasticsearch.action.support.SubscribableListener; | ||
| import org.elasticsearch.client.internal.Client; | ||
| import org.elasticsearch.client.internal.OriginSettingClient; | ||
| import org.elasticsearch.cluster.ClusterState; | ||
| import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver; | ||
| import org.elasticsearch.cluster.routing.IndexRoutingTable; | ||
| import org.elasticsearch.index.IndexVersion; | ||
| import org.elasticsearch.index.IndexVersions; | ||
| import org.elasticsearch.logging.LogManager; | ||
| import org.elasticsearch.logging.Logger; | ||
| import org.elasticsearch.rest.RestStatus; | ||
| import org.elasticsearch.xpack.core.ml.utils.MlIndexAndAlias; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import static org.elasticsearch.xpack.core.ClientHelper.ML_ORIGIN; | ||
|
|
||
| /** | ||
| * If any of the indices listed in {@code indicesToRollover} are legacy indices | ||
| * then call rollover to produce a new index with the current version. If the | ||
| * index does not have an alias the alias is created first. | ||
| * If none of the {@code indicesToRollover} exist or they are all non-legacy | ||
| * indices then nothing will be updated. | ||
| */ | ||
| public class MlIndexRollover implements MlAutoUpdateService.UpdateAction { | ||
|
|
||
| private static final Logger logger = LogManager.getLogger(MlIndexRollover.class); | ||
|
|
||
| public record IndexPatternAndAlias(String indexPattern, String alias) {} | ||
|
|
||
| private final IndexNameExpressionResolver expressionResolver; | ||
| private final OriginSettingClient client; | ||
| private final List<IndexPatternAndAlias> indicesToRollover; | ||
|
|
||
| public MlIndexRollover(List<IndexPatternAndAlias> indicesToRollover, IndexNameExpressionResolver expressionResolver, Client client) { | ||
| this.expressionResolver = expressionResolver; | ||
| this.client = new OriginSettingClient(client, ML_ORIGIN); | ||
| this.indicesToRollover = indicesToRollover; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isMinTransportVersionSupported(TransportVersion minTransportVersion) { | ||
| // Wait for all nodes to be upgraded to ensure that the | ||
| // newly created index will be of the latest version. | ||
| return minTransportVersion.onOrAfter(TransportVersions.ML_ROLLOVER_LEGACY_INDICES); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isAbleToRun(ClusterState latestState) { | ||
| for (var indexPatternAndAlias : indicesToRollover) { | ||
| String[] indices = expressionResolver.concreteIndexNames( | ||
| latestState, | ||
| IndicesOptions.lenientExpandOpenHidden(), | ||
| indexPatternAndAlias.indexPattern | ||
| ); | ||
| if (indices.length == 0) { | ||
| // The index does not exist but the MlAutoUpdateService will | ||
| // need to run this action and mark it as done. | ||
| // Ignore the missing index and continue the loop | ||
| continue; | ||
| } | ||
|
|
||
| String latestIndex = MlIndexAndAlias.latestIndex(indices); | ||
| IndexRoutingTable routingTable = latestState.getRoutingTable().index(latestIndex); | ||
| if (routingTable == null || routingTable.allPrimaryShardsActive() == false) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return "ml_legacy_index_rollover"; | ||
| } | ||
|
|
||
| @Override | ||
| public void runUpdate(ClusterState latestState) { | ||
| List<Exception> failures = new ArrayList<>(); | ||
|
|
||
| for (var indexPatternAndAlias : indicesToRollover) { | ||
| PlainActionFuture<Boolean> rolloverIndices = new PlainActionFuture<>(); | ||
| rolloverLegacyIndices(latestState, indexPatternAndAlias.indexPattern(), indexPatternAndAlias.alias(), rolloverIndices); | ||
| try { | ||
| rolloverIndices.actionGet(); | ||
|
There was a problem hiding this comment. Is there any risk of a deadlock here? Or is that avoided because the There was a problem hiding this comment.
This got me thinking 🫢 The good news is that But this code path isn't testing in CI because we don't have testing route for 7 -> 8 -> 9 so I hacked the code to always rollover the index and ran an 8 -> 9 upgrade test. See commit 97995d4 I also added an assertion to check which thread the response comes from and it is the The for loop in Blocking with |
||
| } catch (Exception ex) { | ||
| logger.warn(() -> "failed rolling over legacy index [" + indexPatternAndAlias.indexPattern() + "]", ex); | ||
| if (ex instanceof ElasticsearchException elasticsearchException) { | ||
| failures.add( | ||
| new ElasticsearchStatusException("Failed rollover", elasticsearchException.status(), elasticsearchException) | ||
| ); | ||
| } else { | ||
| failures.add(new ElasticsearchStatusException("Failed rollover", RestStatus.REQUEST_TIMEOUT, ex)); | ||
| } | ||
|
|
||
| break; | ||
| } | ||
| } | ||
|
|
||
| if (failures.isEmpty()) { | ||
| logger.info("ML legacy indies rolled over"); | ||
| return; | ||
| } | ||
|
|
||
| ElasticsearchException exception = new ElasticsearchException("some error"); | ||
| failures.forEach(exception::addSuppressed); | ||
| throw exception; | ||
| } | ||
|
|
||
| private void rolloverLegacyIndices(ClusterState clusterState, String indexPattern, String alias, ActionListener<Boolean> listener) { | ||
| var concreteIndices = expressionResolver.concreteIndexNames(clusterState, IndicesOptions.LENIENT_EXPAND_OPEN_CLOSED, indexPattern); | ||
|
|
||
| if (concreteIndices.length == 0) { | ||
| // no matching indices | ||
| listener.onResponse(Boolean.FALSE); | ||
| return; | ||
| } | ||
|
|
||
| String latestIndex = MlIndexAndAlias.latestIndex(concreteIndices); | ||
| boolean isCompatibleIndexVersion = isCompatibleIndexVersion(clusterState.metadata().index(latestIndex).getCreationVersion()); | ||
| boolean hasAlias = clusterState.getMetadata().hasAlias(alias); | ||
|
|
||
| if (isCompatibleIndexVersion && hasAlias) { | ||
| // v8 index with alias, no action required | ||
| listener.onResponse(Boolean.FALSE); | ||
| return; | ||
| } | ||
|
|
||
| SubscribableListener.<Boolean>newForked(l -> { | ||
| if (hasAlias == false) { | ||
| MlIndexAndAlias.updateWriteAlias(client, alias, null, latestIndex, l); | ||
| } else { | ||
| l.onResponse(Boolean.TRUE); | ||
| } | ||
| }).<Boolean>andThen((l, success) -> { | ||
| if (isCompatibleIndexVersion == false) { | ||
| logger.info("rolling over legacy index [{}] with alias [{}]", latestIndex, alias); | ||
| rollover(alias, l); | ||
| } else { | ||
| l.onResponse(Boolean.TRUE); | ||
| } | ||
| }).addListener(listener); | ||
| } | ||
|
|
||
| private void rollover(String alias, ActionListener<Boolean> listener) { | ||
| client.admin().indices().rolloverIndex(new RolloverRequest(alias, null), listener.delegateFailure((l, response) -> { | ||
| l.onResponse(Boolean.TRUE); | ||
| })); | ||
| } | ||
|
|
||
| /** | ||
| * True if the version is read *and* write compatible not just read only compatible | ||
| */ | ||
| static boolean isCompatibleIndexVersion(IndexVersion version) { | ||
| return version.onOrAfter(IndexVersions.MINIMUM_COMPATIBLE); | ||
| } | ||
| } | ||
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this will effectively wait until the entire cluster is on 8.x or later, guaranteeing that the index will be created as v8?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I've updated the comment to that effect