-
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.
Wildcard cluster names for cross cluster search (#23985)
This is related to #23893. This commit allows users to use wilcards for cluster names when executing a cross cluster search. So instead of defining every cluster such as: GET one:*,two:*,three:*/_search A user could just search: GET *:*/_search As ":" characters are currently allowed in index names, if the text up to the first ":" does not match a defined cluster name, the entire string is treated as an index name.
- Loading branch information
1 parent
c17bee5
commit cf6b03c
Showing
5 changed files
with
218 additions
and
10 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
100 changes: 100 additions & 0 deletions
100
core/src/main/java/org/elasticsearch/cluster/metadata/ClusterNameExpressionResolver.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,100 @@ | ||
| /* | ||
| * 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.metadata; | ||
|
|
||
| import org.elasticsearch.common.component.AbstractComponent; | ||
| import org.elasticsearch.common.regex.Regex; | ||
| import org.elasticsearch.common.settings.Settings; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| /** | ||
| * Resolves cluster names from an expression. The expression must be the exact match of a cluster | ||
| * name or must be a wildcard expression. | ||
| */ | ||
| public final class ClusterNameExpressionResolver extends AbstractComponent { | ||
|
|
||
| private final WildcardExpressionResolver wildcardResolver = new WildcardExpressionResolver(); | ||
|
|
||
| public ClusterNameExpressionResolver(Settings settings) { | ||
| super(settings); | ||
| } | ||
|
|
||
| /** | ||
| * Resolves the provided cluster expression to matching cluster names. This method only | ||
| * supports exact or wildcard matches. | ||
| * | ||
| * @param remoteClusters the aliases for remote clusters | ||
| * @param clusterExpression the expressions that can be resolved to cluster names. | ||
| * @return the resolved cluster aliases. | ||
| */ | ||
| public List<String> resolveClusterNames(Set<String> remoteClusters, String clusterExpression) { | ||
| if (remoteClusters.contains(clusterExpression)) { | ||
| return Collections.singletonList(clusterExpression); | ||
| } else if (Regex.isSimpleMatchPattern(clusterExpression)) { | ||
| return wildcardResolver.resolve(remoteClusters, clusterExpression); | ||
| } else { | ||
| return Collections.emptyList(); | ||
| } | ||
| } | ||
|
|
||
| private static class WildcardExpressionResolver { | ||
|
|
||
| private List<String> resolve(Set<String> remoteClusters, String clusterExpression) { | ||
| if (isTrivialWildcard(clusterExpression)) { | ||
| return resolveTrivialWildcard(remoteClusters); | ||
| } | ||
|
|
||
| Set<String> matches = matches(remoteClusters, clusterExpression); | ||
| if (matches.isEmpty()) { | ||
| return Collections.emptyList(); | ||
| } else { | ||
| return new ArrayList<>(matches); | ||
| } | ||
| } | ||
|
|
||
| private boolean isTrivialWildcard(String clusterExpression) { | ||
| return Regex.isMatchAllPattern(clusterExpression); | ||
| } | ||
|
|
||
| private List<String> resolveTrivialWildcard(Set<String> remoteClusters) { | ||
| return new ArrayList<>(remoteClusters); | ||
| } | ||
|
|
||
| private static Set<String> matches(Set<String> remoteClusters, String expression) { | ||
| if (expression.indexOf("*") == expression.length() - 1) { | ||
| return otherWildcard(remoteClusters, expression); | ||
| } else { | ||
| return otherWildcard(remoteClusters, expression); | ||
| } | ||
| } | ||
|
|
||
| private static Set<String> otherWildcard(Set<String> remoteClusters, String expression) { | ||
| final String pattern = expression; | ||
| return remoteClusters.stream() | ||
| .filter(n -> Regex.simpleMatch(pattern, n)) | ||
| .collect(Collectors.toSet()); | ||
| } | ||
| } | ||
| } |
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
75 changes: 75 additions & 0 deletions
75
.../src/test/java/org/elasticsearch/cluster/metadata/ClusterNameExpressionResolverTests.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,75 @@ | ||
| /* | ||
| * 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.metadata; | ||
|
|
||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.test.ESTestCase; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
|
|
||
| public class ClusterNameExpressionResolverTests extends ESTestCase { | ||
|
|
||
| private ClusterNameExpressionResolver clusterNameResolver = new ClusterNameExpressionResolver(Settings.EMPTY); | ||
| private static final Set<String> remoteClusters = new HashSet<>(); | ||
|
|
||
| static { | ||
| remoteClusters.add("cluster1"); | ||
| remoteClusters.add("cluster2"); | ||
| remoteClusters.add("totallyDifferent"); | ||
| } | ||
|
|
||
| public void testExactMatch() { | ||
| List<String> clusters = clusterNameResolver.resolveClusterNames(remoteClusters, "totallyDifferent"); | ||
| assertEquals(new HashSet<>(Arrays.asList("totallyDifferent")), new HashSet<>(clusters)); | ||
| } | ||
|
|
||
| public void testNoWildCardNoMatch() { | ||
| List<String> clusters = clusterNameResolver.resolveClusterNames(remoteClusters, "totallyDifferent2"); | ||
| assertTrue(clusters.isEmpty()); | ||
| } | ||
|
|
||
| public void testWildCardNoMatch() { | ||
| List<String> clusters = clusterNameResolver.resolveClusterNames(remoteClusters, "totally*2"); | ||
| assertTrue(clusters.isEmpty()); | ||
| } | ||
|
|
||
| public void testSimpleWildCard() { | ||
| List<String> clusters = clusterNameResolver.resolveClusterNames(remoteClusters, "*"); | ||
| assertEquals(new HashSet<>(Arrays.asList("cluster1", "cluster2", "totallyDifferent")), new HashSet<>(clusters)); | ||
| } | ||
|
|
||
| public void testSuffixWildCard() { | ||
| List<String> clusters = clusterNameResolver.resolveClusterNames(remoteClusters, "cluster*"); | ||
| assertEquals(new HashSet<>(Arrays.asList("cluster1", "cluster2")), new HashSet<>(clusters)); | ||
| } | ||
|
|
||
| public void testPrefixWildCard() { | ||
| List<String> clusters = clusterNameResolver.resolveClusterNames(remoteClusters, "*Different"); | ||
| assertEquals(new HashSet<>(Arrays.asList("totallyDifferent")), new HashSet<>(clusters)); | ||
| } | ||
|
|
||
| public void testMiddleWildCard() { | ||
| List<String> clusters = clusterNameResolver.resolveClusterNames(remoteClusters, "clu*1"); | ||
| assertEquals(new HashSet<>(Arrays.asList("cluster1")), new HashSet<>(clusters)); | ||
| } | ||
| } |
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