Skip to content

Commit be67852

Browse files
kaushalmahi12Harsh Kothari
kaushalmahi12
authored and
Harsh Kothari
committed
[WLM] Rename queryGroup to workloadGroup (opensearch-project#17901)
* rename queryGroup to workloadGroup Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * fix propagated headers Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * add changelog entry Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * rename queryGroup to workloadGroup Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> * resolve comments Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> --------- Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com> Signed-off-by: Harsh Kothari <techarsh@amazon.com>
1 parent e128811 commit be67852

117 files changed

Lines changed: 4073 additions & 3963 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
4545
- Introduce 512 byte limit to search and ingest pipeline IDs ([#17786](https://github.com/opensearch-project/OpenSearch/pull/17786))
4646
- Avoid skewed segment replication lag metric ([#17831](https://github.com/opensearch-project/OpenSearch/pull/17831))
4747
- Increase the default segment counter step size when replica promoting ([#17568](https://github.com/opensearch-project/OpenSearch/pull/17568))
48+
- [WLM] Rename QueryGroup to WorkloadGroup ([#17901](https://github.com/opensearch-project/OpenSearch/pull/17901))
4849

4950
### Dependencies
5051
- Bump `com.nimbusds:nimbus-jose-jwt` from 9.41.1 to 10.0.2 ([#17607](https://github.com/opensearch-project/OpenSearch/pull/17607), [#17669](https://github.com/opensearch-project/OpenSearch/pull/17669))

‎plugins/workload-management/src/javaRestTest/java/org/opensearch/rest/WorkloadManagementRestIT.java‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -19,58 +19,58 @@
1919
public class WorkloadManagementRestIT extends OpenSearchRestTestCase {
2020

2121
public void testCreate() throws Exception {
22-
Response response = performOperation("PUT", "_wlm/query_group", getCreateJson("analytics", "enforced", 0.4, 0.2));
22+
Response response = performOperation("PUT", "_wlm/workload_group", getCreateJson("analytics", "enforced", 0.4, 0.2));
2323
assertEquals(response.getStatusLine().getStatusCode(), 200);
24-
performOperation("DELETE", "_wlm/query_group/analytics", null);
24+
performOperation("DELETE", "_wlm/workload_group/analytics", null);
2525
}
2626

2727
public void testMultipleCreate() throws Exception {
28-
Response response = performOperation("PUT", "_wlm/query_group", getCreateJson("analytics2", "enforced", 0.4, 0.2));
28+
Response response = performOperation("PUT", "_wlm/workload_group", getCreateJson("analytics2", "enforced", 0.4, 0.2));
2929
assertEquals(response.getStatusLine().getStatusCode(), 200);
3030

31-
Response response2 = performOperation("PUT", "_wlm/query_group", getCreateJson("users", "soft", 0.2, 0.1));
31+
Response response2 = performOperation("PUT", "_wlm/workload_group", getCreateJson("users", "soft", 0.2, 0.1));
3232
assertEquals(response2.getStatusLine().getStatusCode(), 200);
3333

3434
assertThrows(
3535
ResponseException.class,
36-
() -> performOperation("PUT", "_wlm/query_group", getCreateJson("users2", "soft", 0.41, 0.71))
36+
() -> performOperation("PUT", "_wlm/workload_group", getCreateJson("users2", "soft", 0.41, 0.71))
3737
);
38-
performOperation("DELETE", "_wlm/query_group/analytics2", null);
39-
performOperation("DELETE", "_wlm/query_group/users", null);
38+
performOperation("DELETE", "_wlm/workload_group/analytics2", null);
39+
performOperation("DELETE", "_wlm/workload_group/users", null);
4040
}
4141

4242
public void testGet() throws Exception {
43-
Response response = performOperation("PUT", "_wlm/query_group", getCreateJson("analytics3", "enforced", 0.4, 0.2));
43+
Response response = performOperation("PUT", "_wlm/workload_group", getCreateJson("analytics3", "enforced", 0.4, 0.2));
4444
assertEquals(response.getStatusLine().getStatusCode(), 200);
4545

46-
Response response2 = performOperation("GET", "_wlm/query_group/analytics3", null);
46+
Response response2 = performOperation("GET", "_wlm/workload_group/analytics3", null);
4747
assertEquals(response2.getStatusLine().getStatusCode(), 200);
4848
String responseBody2 = EntityUtils.toString(response2.getEntity());
4949
assertTrue(responseBody2.contains("\"name\":\"analytics3\""));
5050
assertTrue(responseBody2.contains("\"resiliency_mode\":\"enforced\""));
5151
assertTrue(responseBody2.contains("\"cpu\":0.4"));
5252
assertTrue(responseBody2.contains("\"memory\":0.2"));
5353

54-
assertThrows(ResponseException.class, () -> performOperation("GET", "_wlm/query_group/analytics97", null));
55-
performOperation("DELETE", "_wlm/query_group/analytics3", null);
54+
assertThrows(ResponseException.class, () -> performOperation("GET", "_wlm/workload_group/analytics97", null));
55+
performOperation("DELETE", "_wlm/workload_group/analytics3", null);
5656
}
5757

5858
public void testDelete() throws Exception {
59-
Response response = performOperation("PUT", "_wlm/query_group", getCreateJson("analytics4", "enforced", 0.4, 0.2));
59+
Response response = performOperation("PUT", "_wlm/workload_group", getCreateJson("analytics4", "enforced", 0.4, 0.2));
6060
assertEquals(response.getStatusLine().getStatusCode(), 200);
6161

62-
Response response2 = performOperation("DELETE", "_wlm/query_group/analytics4", null);
62+
Response response2 = performOperation("DELETE", "_wlm/workload_group/analytics4", null);
6363
assertEquals(response2.getStatusLine().getStatusCode(), 200);
6464
assertTrue(EntityUtils.toString(response2.getEntity()).contains("\"acknowledged\":true"));
6565

66-
assertThrows(ResponseException.class, () -> performOperation("DELETE", "_wlm/query_group/analytics99", null));
66+
assertThrows(ResponseException.class, () -> performOperation("DELETE", "_wlm/workload_group/analytics99", null));
6767
}
6868

6969
public void testUpdate() throws Exception {
70-
Response response = performOperation("PUT", "_wlm/query_group", getCreateJson("analytics5", "enforced", 0.4, 0.2));
70+
Response response = performOperation("PUT", "_wlm/workload_group", getCreateJson("analytics5", "enforced", 0.4, 0.2));
7171
assertEquals(response.getStatusLine().getStatusCode(), 200);
7272

73-
Response response2 = performOperation("PUT", "_wlm/query_group/analytics5", getUpdateJson("monitor", 0.41, 0.21));
73+
Response response2 = performOperation("PUT", "_wlm/workload_group/analytics5", getUpdateJson("monitor", 0.41, 0.21));
7474
assertEquals(response2.getStatusLine().getStatusCode(), 200);
7575
String responseBody2 = EntityUtils.toString(response2.getEntity());
7676
assertTrue(responseBody2.contains("\"name\":\"analytics5\""));
@@ -84,22 +84,22 @@ public void testUpdate() throws Exception {
8484
+ " \"memory\" : -0.1\n"
8585
+ " }\n"
8686
+ "}'";
87-
assertThrows(ResponseException.class, () -> performOperation("PUT", "_wlm/query_group/analytics5", json));
87+
assertThrows(ResponseException.class, () -> performOperation("PUT", "_wlm/workload_group/analytics5", json));
8888
assertThrows(
8989
ResponseException.class,
90-
() -> performOperation("PUT", "_wlm/query_group/analytics98", getUpdateJson("monitor", 0.43, 0.23))
90+
() -> performOperation("PUT", "_wlm/workload_group/analytics98", getUpdateJson("monitor", 0.43, 0.23))
9191
);
92-
performOperation("DELETE", "_wlm/query_group/analytics5", null);
92+
performOperation("DELETE", "_wlm/workload_group/analytics5", null);
9393
}
9494

9595
public void testCRUD() throws Exception {
96-
Response response = performOperation("PUT", "_wlm/query_group", getCreateJson("analytics6", "enforced", 0.4, 0.2));
96+
Response response = performOperation("PUT", "_wlm/workload_group", getCreateJson("analytics6", "enforced", 0.4, 0.2));
9797
assertEquals(response.getStatusLine().getStatusCode(), 200);
9898

99-
Response response1 = performOperation("PUT", "_wlm/query_group/analytics6", getUpdateJson("monitor", 0.41, 0.21));
99+
Response response1 = performOperation("PUT", "_wlm/workload_group/analytics6", getUpdateJson("monitor", 0.41, 0.21));
100100
assertEquals(response1.getStatusLine().getStatusCode(), 200);
101101

102-
Response response2 = performOperation("GET", "_wlm/query_group/analytics6", null);
102+
Response response2 = performOperation("GET", "_wlm/workload_group/analytics6", null);
103103
assertEquals(response2.getStatusLine().getStatusCode(), 200);
104104
String responseBody2 = EntityUtils.toString(response2.getEntity());
105105
assertTrue(responseBody2.contains("\"name\":\"analytics6\""));
@@ -109,24 +109,24 @@ public void testCRUD() throws Exception {
109109

110110
assertThrows(
111111
ResponseException.class,
112-
() -> performOperation("PUT", "_wlm/query_group", getCreateJson("users3", "monitor", 0.6, 0.8))
112+
() -> performOperation("PUT", "_wlm/workload_group", getCreateJson("users3", "monitor", 0.6, 0.8))
113113
);
114114

115-
Response response4 = performOperation("PUT", "_wlm/query_group", getCreateJson("users3", "monitor", 0.59, 0.79));
115+
Response response4 = performOperation("PUT", "_wlm/workload_group", getCreateJson("users3", "monitor", 0.59, 0.79));
116116
assertEquals(response4.getStatusLine().getStatusCode(), 200);
117117

118-
Response response5 = performOperation("DELETE", "_wlm/query_group/analytics6", null);
118+
Response response5 = performOperation("DELETE", "_wlm/workload_group/analytics6", null);
119119
assertEquals(response5.getStatusLine().getStatusCode(), 200);
120120
String responseBody5 = EntityUtils.toString(response5.getEntity());
121121
assertTrue(responseBody5.contains("\"acknowledged\":true"));
122122

123-
Response response6 = performOperation("GET", "_wlm/query_group", null);
123+
Response response6 = performOperation("GET", "_wlm/workload_group", null);
124124
assertEquals(response6.getStatusLine().getStatusCode(), 200);
125125
String responseBody6 = EntityUtils.toString(response6.getEntity());
126-
assertTrue(responseBody6.contains("\"query_groups\""));
126+
assertTrue(responseBody6.contains("\"workload_groups\""));
127127
assertTrue(responseBody6.contains("\"users3\""));
128128
assertFalse(responseBody6.contains("\"analytics6\""));
129-
performOperation("DELETE", "_wlm/query_group/users3", null);
129+
performOperation("DELETE", "_wlm/workload_group/users3", null);
130130
}
131131

132132
static String getCreateJson(String name, String resiliencyMode, double cpu, double memory) {

‎plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/WorkloadManagementPlugin.java‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@
1818
import org.opensearch.common.settings.Settings;
1919
import org.opensearch.common.settings.SettingsFilter;
2020
import org.opensearch.core.action.ActionResponse;
21-
import org.opensearch.plugin.wlm.action.CreateQueryGroupAction;
22-
import org.opensearch.plugin.wlm.action.DeleteQueryGroupAction;
23-
import org.opensearch.plugin.wlm.action.GetQueryGroupAction;
24-
import org.opensearch.plugin.wlm.action.TransportCreateQueryGroupAction;
25-
import org.opensearch.plugin.wlm.action.TransportDeleteQueryGroupAction;
26-
import org.opensearch.plugin.wlm.action.TransportGetQueryGroupAction;
27-
import org.opensearch.plugin.wlm.action.TransportUpdateQueryGroupAction;
28-
import org.opensearch.plugin.wlm.action.UpdateQueryGroupAction;
29-
import org.opensearch.plugin.wlm.rest.RestCreateQueryGroupAction;
30-
import org.opensearch.plugin.wlm.rest.RestDeleteQueryGroupAction;
31-
import org.opensearch.plugin.wlm.rest.RestGetQueryGroupAction;
32-
import org.opensearch.plugin.wlm.rest.RestUpdateQueryGroupAction;
33-
import org.opensearch.plugin.wlm.service.QueryGroupPersistenceService;
21+
import org.opensearch.plugin.wlm.action.CreateWorkloadGroupAction;
22+
import org.opensearch.plugin.wlm.action.DeleteWorkloadGroupAction;
23+
import org.opensearch.plugin.wlm.action.GetWorkloadGroupAction;
24+
import org.opensearch.plugin.wlm.action.TransportCreateWorkloadGroupAction;
25+
import org.opensearch.plugin.wlm.action.TransportDeleteWorkloadGroupAction;
26+
import org.opensearch.plugin.wlm.action.TransportGetWorkloadGroupAction;
27+
import org.opensearch.plugin.wlm.action.TransportUpdateWorkloadGroupAction;
28+
import org.opensearch.plugin.wlm.action.UpdateWorkloadGroupAction;
29+
import org.opensearch.plugin.wlm.rest.RestCreateWorkloadGroupAction;
30+
import org.opensearch.plugin.wlm.rest.RestDeleteWorkloadGroupAction;
31+
import org.opensearch.plugin.wlm.rest.RestGetWorkloadGroupAction;
32+
import org.opensearch.plugin.wlm.rest.RestUpdateWorkloadGroupAction;
33+
import org.opensearch.plugin.wlm.service.WorkloadGroupPersistenceService;
3434
import org.opensearch.plugins.ActionPlugin;
3535
import org.opensearch.plugins.Plugin;
3636
import org.opensearch.rest.RestController;
@@ -53,10 +53,10 @@ public WorkloadManagementPlugin() {}
5353
@Override
5454
public List<ActionHandler<? extends ActionRequest, ? extends ActionResponse>> getActions() {
5555
return List.of(
56-
new ActionPlugin.ActionHandler<>(CreateQueryGroupAction.INSTANCE, TransportCreateQueryGroupAction.class),
57-
new ActionPlugin.ActionHandler<>(GetQueryGroupAction.INSTANCE, TransportGetQueryGroupAction.class),
58-
new ActionPlugin.ActionHandler<>(DeleteQueryGroupAction.INSTANCE, TransportDeleteQueryGroupAction.class),
59-
new ActionPlugin.ActionHandler<>(UpdateQueryGroupAction.INSTANCE, TransportUpdateQueryGroupAction.class)
56+
new ActionPlugin.ActionHandler<>(CreateWorkloadGroupAction.INSTANCE, TransportCreateWorkloadGroupAction.class),
57+
new ActionPlugin.ActionHandler<>(GetWorkloadGroupAction.INSTANCE, TransportGetWorkloadGroupAction.class),
58+
new ActionPlugin.ActionHandler<>(DeleteWorkloadGroupAction.INSTANCE, TransportDeleteWorkloadGroupAction.class),
59+
new ActionPlugin.ActionHandler<>(UpdateWorkloadGroupAction.INSTANCE, TransportUpdateWorkloadGroupAction.class)
6060
);
6161
}
6262

@@ -71,16 +71,16 @@ public List<RestHandler> getRestHandlers(
7171
Supplier<DiscoveryNodes> nodesInCluster
7272
) {
7373
return List.of(
74-
new RestCreateQueryGroupAction(),
75-
new RestGetQueryGroupAction(),
76-
new RestDeleteQueryGroupAction(),
77-
new RestUpdateQueryGroupAction()
74+
new RestCreateWorkloadGroupAction(),
75+
new RestGetWorkloadGroupAction(),
76+
new RestDeleteWorkloadGroupAction(),
77+
new RestUpdateWorkloadGroupAction()
7878
);
7979
}
8080

8181
@Override
8282
public List<Setting<?>> getSettings() {
83-
return List.of(QueryGroupPersistenceService.MAX_QUERY_GROUP_COUNT);
83+
return List.of(WorkloadGroupPersistenceService.MAX_QUERY_GROUP_COUNT);
8484
}
8585

8686
@Override

‎plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/WorkloadManagementPluginModule.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
import org.opensearch.common.inject.AbstractModule;
1212
import org.opensearch.common.inject.Singleton;
13-
import org.opensearch.plugin.wlm.service.QueryGroupPersistenceService;
13+
import org.opensearch.plugin.wlm.service.WorkloadGroupPersistenceService;
1414

1515
/**
1616
* Guice Module to manage WorkloadManagement related objects
@@ -24,8 +24,8 @@ public WorkloadManagementPluginModule() {}
2424

2525
@Override
2626
protected void configure() {
27-
// Bind QueryGroupPersistenceService as a singleton to ensure a single instance is used,
27+
// Bind WorkloadGroupPersistenceService as a singleton to ensure a single instance is used,
2828
// preventing multiple throttling key registrations in the constructor.
29-
bind(QueryGroupPersistenceService.class).in(Singleton.class);
29+
bind(WorkloadGroupPersistenceService.class).in(Singleton.class);
3030
}
3131
}

plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/action/UpdateQueryGroupAction.java renamed to plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/action/CreateWorkloadGroupAction.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,26 @@
1111
import org.opensearch.action.ActionType;
1212

1313
/**
14-
* Transport action to update QueryGroup
14+
* Transport action to create WorkloadGroup
1515
*
1616
* @opensearch.experimental
1717
*/
18-
public class UpdateQueryGroupAction extends ActionType<UpdateQueryGroupResponse> {
18+
public class CreateWorkloadGroupAction extends ActionType<CreateWorkloadGroupResponse> {
1919

2020
/**
21-
* An instance of UpdateQueryGroupAction
21+
* An instance of CreateWorkloadGroupAction
2222
*/
23-
public static final UpdateQueryGroupAction INSTANCE = new UpdateQueryGroupAction();
23+
public static final CreateWorkloadGroupAction INSTANCE = new CreateWorkloadGroupAction();
2424

2525
/**
26-
* Name for UpdateQueryGroupAction
26+
* Name for CreateWorkloadGroupAction
2727
*/
28-
public static final String NAME = "cluster:admin/opensearch/wlm/query_group/_update";
28+
public static final String NAME = "cluster:admin/opensearch/wlm/workload_group/_create";
2929

3030
/**
3131
* Default constructor
3232
*/
33-
private UpdateQueryGroupAction() {
34-
super(NAME, UpdateQueryGroupResponse::new);
33+
private CreateWorkloadGroupAction() {
34+
super(NAME, CreateWorkloadGroupResponse::new);
3535
}
3636
}

plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/action/CreateQueryGroupRequest.java renamed to plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/action/CreateWorkloadGroupRequest.java

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
import org.opensearch.action.ActionRequestValidationException;
1212
import org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest;
13-
import org.opensearch.cluster.metadata.QueryGroup;
13+
import org.opensearch.cluster.metadata.WorkloadGroup;
1414
import org.opensearch.common.UUIDs;
1515
import org.opensearch.core.common.io.stream.StreamInput;
1616
import org.opensearch.core.common.io.stream.StreamOutput;
@@ -20,7 +20,7 @@
2020
import java.io.IOException;
2121

2222
/**
23-
* A request for create QueryGroup
23+
* A request for create WorkloadGroup
2424
* User input schema:
2525
* {
2626
* "name": "analytics",
@@ -33,33 +33,33 @@
3333
*
3434
* @opensearch.experimental
3535
*/
36-
public class CreateQueryGroupRequest extends ClusterManagerNodeRequest<CreateQueryGroupRequest> {
37-
private final QueryGroup queryGroup;
36+
public class CreateWorkloadGroupRequest extends ClusterManagerNodeRequest<CreateWorkloadGroupRequest> {
37+
private final WorkloadGroup workloadGroup;
3838

3939
/**
40-
* Constructor for CreateQueryGroupRequest
41-
* @param queryGroup - A {@link QueryGroup} object
40+
* Constructor for CreateWorkloadGroupRequest
41+
* @param workloadGroup - A {@link WorkloadGroup} object
4242
*/
43-
CreateQueryGroupRequest(QueryGroup queryGroup) {
44-
this.queryGroup = queryGroup;
43+
CreateWorkloadGroupRequest(WorkloadGroup workloadGroup) {
44+
this.workloadGroup = workloadGroup;
4545
}
4646

4747
/**
48-
* Constructor for CreateQueryGroupRequest
48+
* Constructor for CreateWorkloadGroupRequest
4949
* @param in - A {@link StreamInput} object
5050
*/
51-
CreateQueryGroupRequest(StreamInput in) throws IOException {
51+
CreateWorkloadGroupRequest(StreamInput in) throws IOException {
5252
super(in);
53-
queryGroup = new QueryGroup(in);
53+
workloadGroup = new WorkloadGroup(in);
5454
}
5555

5656
/**
57-
* Generate a CreateQueryGroupRequest from XContent
57+
* Generate a CreateWorkloadGroupRequest from XContent
5858
* @param parser - A {@link XContentParser} object
5959
*/
60-
public static CreateQueryGroupRequest fromXContent(XContentParser parser) throws IOException {
61-
QueryGroup.Builder builder = QueryGroup.Builder.fromXContent(parser);
62-
return new CreateQueryGroupRequest(builder._id(UUIDs.randomBase64UUID()).updatedAt(Instant.now().getMillis()).build());
60+
public static CreateWorkloadGroupRequest fromXContent(XContentParser parser) throws IOException {
61+
WorkloadGroup.Builder builder = WorkloadGroup.Builder.fromXContent(parser);
62+
return new CreateWorkloadGroupRequest(builder._id(UUIDs.randomBase64UUID()).updatedAt(Instant.now().getMillis()).build());
6363
}
6464

6565
@Override
@@ -70,13 +70,13 @@ public ActionRequestValidationException validate() {
7070
@Override
7171
public void writeTo(StreamOutput out) throws IOException {
7272
super.writeTo(out);
73-
queryGroup.writeTo(out);
73+
workloadGroup.writeTo(out);
7474
}
7575

7676
/**
77-
* QueryGroup getter
77+
* WorkloadGroup getter
7878
*/
79-
public QueryGroup getQueryGroup() {
80-
return queryGroup;
79+
public WorkloadGroup getWorkloadGroup() {
80+
return workloadGroup;
8181
}
8282
}

0 commit comments

Comments
 (0)