honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add 'cluster_manager_node' into ClusterState Metric as an alternative to 'master_node' (#2415) 

* Add `cluster_manager_node` into `ClusterState Metric`, as an alternative to `master_node`. So that the request parameter "metric" in `Cluster reroute` and `Cluster state` API accept the new value `cluster_manager_node`
* Deprecate the enum value of `Metric: MASTER_NODE("master_node")`
* Add YAML REST tests for the new parameter value for "cluster state" and "cluster reroute" API

Signed-off-by: Tianli Feng <ftianli@amazon.com>
This commit is contained in:
Tianli Feng 2022-03-18 15:09:37 -07:00 committed by GitHub
parent ea31483126
commit e0f770643c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 112 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
rest-api-spec/src/main/resources/rest-api-spec/api/cluster.reroute.json
View File

@ -37,6 +37,7 @@
"nodes",
"routing_table",
"master_node",
"cluster_manager_node",
"version"
],
"description":"Limit the information returned to the specified metrics. Defaults to all but metadata"

1
rest-api-spec/src/main/resources/rest-api-spec/api/cluster.state.json
View File

@ -55,6 +55,7 @@
"routing_table",
"routing_nodes",
"master_node",
"cluster_manager_node",
"version"
],
"description":"Limit the information returned to the specified metrics"

15
rest-api-spec/src/main/resources/rest-api-spec/test/cluster.reroute/10_basic.yml
View File

@ -2,3 +2,18 @@
"Basic sanity check":
- do:
cluster.reroute: {}
---
"Cluster reroute returns cluster_manager_node":
- skip:
version: " - 1.4.99"
reason: "The metric cluster_manager_node is added to cluster state in version 2.0.0"
- do:
cluster.reroute: {}
- set:
state.cluster_manager_node: node_id
- match: {state.master_node: $node_id}
- match: {state.cluster_manager_node: $node_id}

13
rest-api-spec/src/main/resources/rest-api-spec/test/cluster.reroute/20_response_filtering.yml
View File

@ -3,6 +3,7 @@
- do:
cluster.reroute: {}
- is_false: state.metadata
---
"return metadata if requested":
- do:
@ -12,3 +13,15 @@
- is_true: state.metadata
- is_false: state.nodes
---
"Filter the cluster reroute by cluster_manager_node only should work":
- skip:
version: " - 1.4.99"
reason: "The metric cluster_manager_node is added to cluster state in version 2.0.0"
- do:
cluster.reroute:
metric: [ cluster_manager_node ]
- is_true: state.cluster_manager_node
- is_false: state.master_node

15
rest-api-spec/src/main/resources/rest-api-spec/test/cluster.state/10_basic.yml
View File

@ -17,3 +17,18 @@
- is_true: cluster_uuid
- is_true: master_node
---
"Get cluster state returns cluster_manager_node":
- skip:
version: " - 1.4.99"
reason: "The metric cluster_manager_node is added to cluster state in version 2.0.0"
- do:
cluster.state: {}
- set:
cluster_manager_node: node_id
- match: {master_node: $node_id}
- match: {cluster_manager_node: $node_id}

16
rest-api-spec/src/main/resources/rest-api-spec/test/cluster.state/20_filtering.yml
View File

@ -158,6 +158,7 @@ setup:
- skip:
version: " - 6.3.99"
reason: "cluster state including cluster_uuid at the top level is new in v6.4.0 and higher"
features: allowed_warnings
# Get the current cluster_uuid
- do:
@ -167,6 +168,8 @@ setup:
- do:
cluster.state:
metric: [ master_node, version ]
allowed_warnings:
- 'Deprecated value [master_node] used for parameter [metric]. To promote inclusive language, please use [cluster_manager_node] instead. It will be unsupported in a future major version.'
- match: { cluster_uuid: $cluster_uuid }
- is_true: master_node
@ -180,3 +183,16 @@ setup:
- match: { cluster_uuid: $cluster_uuid }
- is_true: routing_table
---
"Filter the cluster state by cluster_manager_node only should work":
- skip:
version: " - 1.4.99"
reason: "The metric cluster_manager_node is added to cluster state in version 2.0.0"
- do:
cluster.state:
metric: [ cluster_manager_node ]
- is_true: cluster_manager_node
- is_false: master_node

11
server/src/main/java/org/opensearch/cluster/ClusterState.java
View File

@ -402,7 +402,13 @@ public class ClusterState implements ToXContentFragment, Diffable<ClusterState>
public enum Metric {
VERSION("version"),
/**
* @deprecated As of 2.0, because promoting inclusive language, replaced by {@link #CLUSTER_MANAGER_NODE}
*/
@Deprecated
MASTER_NODE("master_node"),
CLUSTER_MANAGER_NODE("cluster_manager_node"),
BLOCKS("blocks"),
NODES("nodes"),
METADATA("metadata"),
@ -467,6 +473,11 @@ public class ClusterState implements ToXContentFragment, Diffable<ClusterState>
builder.field("master_node", nodes().getMasterNodeId());
}
// Value of the field is identical with the above, and aims to replace the above field.
if (metrics.contains(Metric.CLUSTER_MANAGER_NODE)) {
builder.field("cluster_manager_node", nodes().getMasterNodeId());
}
if (metrics.contains(Metric.BLOCKS)) {
builder.startObject("blocks");

15
server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterRerouteAction.java
View File

@ -39,6 +39,7 @@ import org.opensearch.cluster.ClusterState;
import org.opensearch.cluster.routing.allocation.command.AllocationCommands;
import org.opensearch.common.ParseField;
import org.opensearch.common.Strings;
import org.opensearch.common.logging.DeprecationLogger;
import org.opensearch.common.settings.Settings;
import org.opensearch.common.settings.SettingsFilter;
import org.opensearch.common.xcontent.ObjectParser;
@ -78,6 +79,12 @@ public class RestClusterRerouteAction extends BaseRestHandler {
this.settingsFilter = settingsFilter;
}
// TODO: Remove the DeprecationLogger after removing MASTER_ROLE.
// It's used to log deprecation when request parameter 'metric' contains 'master_node'.
private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestClusterRerouteAction.class);
private static final String DEPRECATED_MESSAGE_MASTER_NODE =
"Deprecated value [master_node] used for parameter [metric]. To promote inclusive language, please use [cluster_manager_node] instead. It will be unsupported in a future major version.";
@Override
public List<Route> routes() {
return singletonList(new Route(POST, "/_cluster/reroute"));
@ -104,6 +111,14 @@ public class RestClusterRerouteAction extends BaseRestHandler {
final String metric = request.param("metric");
if (metric == null) {
request.params().put("metric", DEFAULT_METRICS);
} else {
// TODO: Remove the statements in 'else' after removing MASTER_ROLE.
EnumSet<ClusterState.Metric> metrics = ClusterState.Metric.parseString(request.param("metric"), true);
// Because "_all" value will add all Metric into metrics set, for prevent deprecation message shown in that case,
// add the check of validating metrics set doesn't contain all enum elements.
if (!metrics.equals(EnumSet.allOf(ClusterState.Metric.class)) && metrics.contains(ClusterState.Metric.MASTER_NODE)) {
deprecationLogger.deprecate("cluster_reroute_metric_parameter_master_node_value", DEPRECATED_MESSAGE_MASTER_NODE);
}
}
return channel -> client.admin().cluster().reroute(clusterRerouteRequest, new RestToXContentListener<>(channel));
}

19
server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStateAction.java
View File

@ -40,6 +40,7 @@ import org.opensearch.client.node.NodeClient;
import org.opensearch.cluster.ClusterState;
import org.opensearch.cluster.metadata.Metadata;
import org.opensearch.common.Strings;
import org.opensearch.common.logging.DeprecationLogger;
import org.opensearch.common.settings.Settings;
import org.opensearch.common.settings.SettingsFilter;
import org.opensearch.common.xcontent.ToXContent;
@ -71,6 +72,12 @@ public class RestClusterStateAction extends BaseRestHandler {
this.settingsFilter = settingsFilter;
}
// TODO: Remove the DeprecationLogger after removing MASTER_ROLE.
// It's used to log deprecation when request parameter 'metric' contains 'master_node'.
private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestClusterStateAction.class);
private static final String DEPRECATED_MESSAGE_MASTER_NODE =
"Deprecated value [master_node] used for parameter [metric]. To promote inclusive language, please use [cluster_manager_node] instead. It will be unsupported in a future major version.";
@Override
public String getName() {
return "cluster_state_action";
@ -112,7 +119,17 @@ public class RestClusterStateAction extends BaseRestHandler {
if (request.hasParam("metric")) {
EnumSet<ClusterState.Metric> metrics = ClusterState.Metric.parseString(request.param("metric"), true);
// do not ask for what we do not need.
clusterStateRequest.nodes(metrics.contains(ClusterState.Metric.NODES) || metrics.contains(ClusterState.Metric.MASTER_NODE));
clusterStateRequest.nodes(
metrics.contains(ClusterState.Metric.NODES)
|| metrics.contains(ClusterState.Metric.MASTER_NODE)
|| metrics.contains(ClusterState.Metric.CLUSTER_MANAGER_NODE)
);
// TODO: Remove the DeprecationLogger after removing MASTER_ROLE.
// Because "_all" value will add all Metric into metrics set, for prevent deprecation message shown in that case,
// add the check of validating metrics set doesn't contain all enum elements.
if (!metrics.equals(EnumSet.allOf(ClusterState.Metric.class)) && metrics.contains(ClusterState.Metric.MASTER_NODE)) {
deprecationLogger.deprecate("cluster_state_metric_parameter_master_node_value", DEPRECATED_MESSAGE_MASTER_NODE);
}
/*
* there is no distinction in Java api between routing_table and routing_nodes, it's the same info set over the wire, one single
* flag to ask for it

5
server/src/test/java/org/opensearch/action/admin/cluster/reroute/ClusterRerouteResponseTests.java
View File

@ -94,6 +94,7 @@ public class ClusterRerouteResponseTests extends OpenSearchTestCase {
+ clusterState.stateUUID()
+ "\",\n"
+ " \"master_node\" : \"node0\",\n"
+ " \"cluster_manager_node\" : \"node0\",\n"
+ " \"blocks\" : { },\n"
+ " \"nodes\" : {\n"
+ " \"node0\" : {\n"
@ -173,7 +174,7 @@ public class ClusterRerouteResponseTests extends OpenSearchTestCase {
XContentBuilder builder = JsonXContent.contentBuilder().prettyPrint();
Map<String, String> params = new HashMap<>();
params.put("explain", "true");
params.put("metric", "version,master_node");
params.put("metric", "version,cluster_manager_node");
clusterRerouteResponse.toXContent(builder, new ToXContent.MapParams(params));
assertEquals(
"{\n"
@ -184,7 +185,7 @@ public class ClusterRerouteResponseTests extends OpenSearchTestCase {
+ " \"state_uuid\" : \""
+ clusterState.stateUUID()
+ "\",\n"
+ " \"master_node\" : \"node0\"\n"
+ " \"cluster_manager_node\" : \"node0\"\n"
+ " },\n"
+ " \"explanations\" : [\n"
+ " {\n"

4
server/src/test/java/org/opensearch/cluster/ClusterStateTests.java
View File

@ -147,6 +147,7 @@ public class ClusterStateTests extends OpenSearchTestCase {
+ " \"version\" : 0,\n"
+ " \"state_uuid\" : \"stateUUID\",\n"
+ " \"master_node\" : \"masterNodeId\",\n"
+ " \"cluster_manager_node\" : \"masterNodeId\",\n"
+ " \"blocks\" : {\n"
+ " \"global\" : {\n"
+ " \"1\" : {\n"
@ -352,6 +353,7 @@ public class ClusterStateTests extends OpenSearchTestCase {
+ " \"version\" : 0,\n"
+ " \"state_uuid\" : \"stateUUID\",\n"
+ " \"master_node\" : \"masterNodeId\",\n"
+ " \"cluster_manager_node\" : \"masterNodeId\",\n"
+ " \"blocks\" : {\n"
+ " \"global\" : {\n"
+ " \"1\" : {\n"
@ -550,6 +552,7 @@ public class ClusterStateTests extends OpenSearchTestCase {
+ " \"version\" : 0,\n"
+ " \"state_uuid\" : \"stateUUID\",\n"
+ " \"master_node\" : \"masterNodeId\",\n"
+ " \"cluster_manager_node\" : \"masterNodeId\",\n"
+ " \"blocks\" : {\n"
+ " \"global\" : {\n"
+ " \"1\" : {\n"
@ -772,6 +775,7 @@ public class ClusterStateTests extends OpenSearchTestCase {
+ " \"version\" : 0,\n"
+ " \"state_uuid\" : \"stateUUID\",\n"
+ " \"master_node\" : null,\n"
+ " \"cluster_manager_node\" : null,\n"
+ " \"blocks\" : { },\n"
+ " \"nodes\" : { },\n"
+ " \"metadata\" : {\n"