Add create rule api

Signed-off-by: Ruirui Zhang <[email protected]>
opensearch-project · Feb 12, 2025 · bab1e6e · bab1e6e
1 parent 34ef146
commit bab1e6e
Show file tree

Hide file tree

Showing 54 changed files with 1,405 additions and 85 deletions.
diff --git a/...workload-management/src/main/java/org/opensearch/plugin/wlm/WorkloadManagementPlugin.java b/...workload-management/src/main/java/org/opensearch/plugin/wlm/WorkloadManagementPlugin.java
@@ -18,32 +18,39 @@
 import org.opensearch.common.settings.Settings;
 import org.opensearch.common.settings.SettingsFilter;
 import org.opensearch.core.action.ActionResponse;
-import org.opensearch.plugin.wlm.action.CreateQueryGroupAction;
-import org.opensearch.plugin.wlm.action.DeleteQueryGroupAction;
-import org.opensearch.plugin.wlm.action.GetQueryGroupAction;
-import org.opensearch.plugin.wlm.action.TransportCreateQueryGroupAction;
-import org.opensearch.plugin.wlm.action.TransportDeleteQueryGroupAction;
-import org.opensearch.plugin.wlm.action.TransportGetQueryGroupAction;
-import org.opensearch.plugin.wlm.action.TransportUpdateQueryGroupAction;
-import org.opensearch.plugin.wlm.action.UpdateQueryGroupAction;
-import org.opensearch.plugin.wlm.rest.RestCreateQueryGroupAction;
-import org.opensearch.plugin.wlm.rest.RestDeleteQueryGroupAction;
-import org.opensearch.plugin.wlm.rest.RestGetQueryGroupAction;
-import org.opensearch.plugin.wlm.rest.RestUpdateQueryGroupAction;
-import org.opensearch.plugin.wlm.service.QueryGroupPersistenceService;
+import org.opensearch.indices.SystemIndexDescriptor;
+import org.opensearch.plugin.wlm.querygroup.action.CreateQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.DeleteQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.GetQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.TransportCreateQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.TransportDeleteQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.TransportGetQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.TransportUpdateQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.UpdateQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.rest.RestCreateQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.rest.RestDeleteQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.rest.RestGetQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.rest.RestUpdateQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.service.QueryGroupPersistenceService;
+import org.opensearch.plugin.wlm.rule.action.CreateRuleAction;
+import org.opensearch.plugin.wlm.rule.action.TransportCreateRuleAction;
+import org.opensearch.plugin.wlm.rule.rest.RestCreateRuleAction;
 import org.opensearch.plugins.ActionPlugin;
 import org.opensearch.plugins.Plugin;
+import org.opensearch.plugins.SystemIndexPlugin;
 import org.opensearch.rest.RestController;
 import org.opensearch.rest.RestHandler;
 
 import java.util.Collection;
 import java.util.List;
 import java.util.function.Supplier;
 
+import static org.opensearch.plugin.wlm.rule.service.RulePersistenceService.RULE_INDEX;
+
 /**
  * Plugin class for WorkloadManagement
  */
-public class WorkloadManagementPlugin extends Plugin implements ActionPlugin {
+public class WorkloadManagementPlugin extends Plugin implements ActionPlugin, SystemIndexPlugin {
 
     /**
      * Default constructor
@@ -56,10 +63,17 @@ public WorkloadManagementPlugin() {}
             new ActionPlugin.ActionHandler<>(CreateQueryGroupAction.INSTANCE, TransportCreateQueryGroupAction.class),
             new ActionPlugin.ActionHandler<>(GetQueryGroupAction.INSTANCE, TransportGetQueryGroupAction.class),
             new ActionPlugin.ActionHandler<>(DeleteQueryGroupAction.INSTANCE, TransportDeleteQueryGroupAction.class),
-            new ActionPlugin.ActionHandler<>(UpdateQueryGroupAction.INSTANCE, TransportUpdateQueryGroupAction.class)
+            new ActionPlugin.ActionHandler<>(UpdateQueryGroupAction.INSTANCE, TransportUpdateQueryGroupAction.class),
+            new ActionPlugin.ActionHandler<>(CreateRuleAction.INSTANCE, TransportCreateRuleAction.class)
         );
     }
 
+    @Override
+    public Collection<SystemIndexDescriptor> getSystemIndexDescriptors(Settings settings) {
+        List<SystemIndexDescriptor> descriptors = List.of(new SystemIndexDescriptor(RULE_INDEX, "System index used for storing rules"));
+        return descriptors;
+    }
+
     @Override
     public List<RestHandler> getRestHandlers(
         Settings settings,
@@ -74,7 +88,8 @@ public List<RestHandler> getRestHandlers(
             new RestCreateQueryGroupAction(),
             new RestGetQueryGroupAction(),
             new RestDeleteQueryGroupAction(),
-            new RestUpdateQueryGroupAction()
+            new RestUpdateQueryGroupAction(),
+            new RestCreateRuleAction()
         );
     }
 

diff --git a/...ad-management/src/main/java/org/opensearch/plugin/wlm/WorkloadManagementPluginModule.java b/...ad-management/src/main/java/org/opensearch/plugin/wlm/WorkloadManagementPluginModule.java
@@ -10,7 +10,7 @@
 
 import org.opensearch.common.inject.AbstractModule;
 import org.opensearch.common.inject.Singleton;
-import org.opensearch.plugin.wlm.service.QueryGroupPersistenceService;
+import org.opensearch.plugin.wlm.querygroup.service.QueryGroupPersistenceService;
 
 /**
  * Guice Module to manage WorkloadManagement related objects

diff --git a/...in/wlm/action/CreateQueryGroupAction.java → ...ygroup/action/CreateQueryGroupAction.java b/...in/wlm/action/CreateQueryGroupAction.java → ...ygroup/action/CreateQueryGroupAction.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.ActionType;
 

diff --git a/...n/wlm/action/CreateQueryGroupRequest.java → ...group/action/CreateQueryGroupRequest.java b/...n/wlm/action/CreateQueryGroupRequest.java → ...group/action/CreateQueryGroupRequest.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.ActionRequestValidationException;
 import org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest;

diff --git a/.../wlm/action/CreateQueryGroupResponse.java → ...roup/action/CreateQueryGroupResponse.java b/.../wlm/action/CreateQueryGroupResponse.java → ...roup/action/CreateQueryGroupResponse.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.cluster.metadata.QueryGroup;
 import org.opensearch.core.action.ActionResponse;

diff --git a/...in/wlm/action/DeleteQueryGroupAction.java → ...ygroup/action/DeleteQueryGroupAction.java b/...in/wlm/action/DeleteQueryGroupAction.java → ...ygroup/action/DeleteQueryGroupAction.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.ActionType;
 import org.opensearch.action.support.master.AcknowledgedResponse;

diff --git a/...n/wlm/action/DeleteQueryGroupRequest.java → ...group/action/DeleteQueryGroupRequest.java b/...n/wlm/action/DeleteQueryGroupRequest.java → ...group/action/DeleteQueryGroupRequest.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.ActionRequestValidationException;
 import org.opensearch.action.support.master.AcknowledgedRequest;

diff --git a/...lugin/wlm/action/GetQueryGroupAction.java → ...uerygroup/action/GetQueryGroupAction.java b/...lugin/wlm/action/GetQueryGroupAction.java → ...uerygroup/action/GetQueryGroupAction.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.ActionType;
 

diff --git a/...ugin/wlm/action/GetQueryGroupRequest.java → ...erygroup/action/GetQueryGroupRequest.java b/...ugin/wlm/action/GetQueryGroupRequest.java → ...erygroup/action/GetQueryGroupRequest.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.ActionRequestValidationException;
 import org.opensearch.action.support.clustermanager.ClusterManagerNodeReadRequest;

diff --git a/...gin/wlm/action/GetQueryGroupResponse.java → ...rygroup/action/GetQueryGroupResponse.java b/...gin/wlm/action/GetQueryGroupResponse.java → ...rygroup/action/GetQueryGroupResponse.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.cluster.metadata.QueryGroup;
 import org.opensearch.core.action.ActionResponse;

diff --git a/...tion/TransportCreateQueryGroupAction.java → ...tion/TransportCreateQueryGroupAction.java b/...tion/TransportCreateQueryGroupAction.java → ...tion/TransportCreateQueryGroupAction.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.support.ActionFilters;
 import org.opensearch.action.support.clustermanager.TransportClusterManagerNodeAction;
@@ -17,7 +17,7 @@
 import org.opensearch.common.inject.Inject;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.common.io.stream.StreamInput;
-import org.opensearch.plugin.wlm.service.QueryGroupPersistenceService;
+import org.opensearch.plugin.wlm.querygroup.service.QueryGroupPersistenceService;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.TransportService;
 

diff --git a/...tion/TransportDeleteQueryGroupAction.java → ...tion/TransportDeleteQueryGroupAction.java b/...tion/TransportDeleteQueryGroupAction.java → ...tion/TransportDeleteQueryGroupAction.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.support.ActionFilters;
 import org.opensearch.action.support.clustermanager.TransportClusterManagerNodeAction;
@@ -19,7 +19,7 @@
 import org.opensearch.common.inject.Inject;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.common.io.stream.StreamInput;
-import org.opensearch.plugin.wlm.service.QueryGroupPersistenceService;
+import org.opensearch.plugin.wlm.querygroup.service.QueryGroupPersistenceService;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.TransportService;
 

diff --git a/.../action/TransportGetQueryGroupAction.java → .../action/TransportGetQueryGroupAction.java b/.../action/TransportGetQueryGroupAction.java → .../action/TransportGetQueryGroupAction.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -23,7 +23,7 @@
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.rest.RestStatus;
-import org.opensearch.plugin.wlm.service.QueryGroupPersistenceService;
+import org.opensearch.plugin.wlm.querygroup.service.QueryGroupPersistenceService;
 import org.opensearch.search.pipeline.SearchPipelineService;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.TransportService;

diff --git a/...tion/TransportUpdateQueryGroupAction.java → ...tion/TransportUpdateQueryGroupAction.java b/...tion/TransportUpdateQueryGroupAction.java → ...tion/TransportUpdateQueryGroupAction.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.support.ActionFilters;
 import org.opensearch.action.support.clustermanager.TransportClusterManagerNodeAction;
@@ -17,7 +17,7 @@
 import org.opensearch.common.inject.Inject;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.common.io.stream.StreamInput;
-import org.opensearch.plugin.wlm.service.QueryGroupPersistenceService;
+import org.opensearch.plugin.wlm.querygroup.service.QueryGroupPersistenceService;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.TransportService;
 

diff --git a/...in/wlm/action/UpdateQueryGroupAction.java → ...ygroup/action/UpdateQueryGroupAction.java b/...in/wlm/action/UpdateQueryGroupAction.java → ...ygroup/action/UpdateQueryGroupAction.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.ActionType;
 

diff --git a/...n/wlm/action/UpdateQueryGroupRequest.java → ...group/action/UpdateQueryGroupRequest.java b/...n/wlm/action/UpdateQueryGroupRequest.java → ...group/action/UpdateQueryGroupRequest.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.action.ActionRequestValidationException;
 import org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest;

diff --git a/.../wlm/action/UpdateQueryGroupResponse.java → ...roup/action/UpdateQueryGroupResponse.java b/.../wlm/action/UpdateQueryGroupResponse.java → ...roup/action/UpdateQueryGroupResponse.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.action;
+package org.opensearch.plugin.wlm.querygroup.action;
 
 import org.opensearch.cluster.metadata.QueryGroup;
 import org.opensearch.core.action.ActionResponse;

diff --git a/...ad-management/src/main/java/org/opensearch/plugin/wlm/querygroup/action/package-info.java b/...ad-management/src/main/java/org/opensearch/plugin/wlm/querygroup/action/package-info.java
@@ -0,0 +1,12 @@
+/*
+ * 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 for the action classes related to query groups in WorkloadManagementPlugin
+ */
+package org.opensearch.plugin.wlm.querygroup.action;
diff --git a/.../wlm/rest/RestCreateQueryGroupAction.java → ...roup/rest/RestCreateQueryGroupAction.java b/.../wlm/rest/RestCreateQueryGroupAction.java → ...roup/rest/RestCreateQueryGroupAction.java
@@ -6,15 +6,15 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.rest;
+package org.opensearch.plugin.wlm.querygroup.rest;
 
 import org.opensearch.client.node.NodeClient;
 import org.opensearch.core.rest.RestStatus;
 import org.opensearch.core.xcontent.ToXContent;
 import org.opensearch.core.xcontent.XContentParser;
-import org.opensearch.plugin.wlm.action.CreateQueryGroupAction;
-import org.opensearch.plugin.wlm.action.CreateQueryGroupRequest;
-import org.opensearch.plugin.wlm.action.CreateQueryGroupResponse;
+import org.opensearch.plugin.wlm.querygroup.action.CreateQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.CreateQueryGroupRequest;
+import org.opensearch.plugin.wlm.querygroup.action.CreateQueryGroupResponse;
 import org.opensearch.rest.BaseRestHandler;
 import org.opensearch.rest.BytesRestResponse;
 import org.opensearch.rest.RestChannel;

diff --git a/.../wlm/rest/RestDeleteQueryGroupAction.java → ...roup/rest/RestDeleteQueryGroupAction.java b/.../wlm/rest/RestDeleteQueryGroupAction.java → ...roup/rest/RestDeleteQueryGroupAction.java
@@ -6,11 +6,11 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.rest;
+package org.opensearch.plugin.wlm.querygroup.rest;
 
 import org.opensearch.client.node.NodeClient;
-import org.opensearch.plugin.wlm.action.DeleteQueryGroupAction;
-import org.opensearch.plugin.wlm.action.DeleteQueryGroupRequest;
+import org.opensearch.plugin.wlm.querygroup.action.DeleteQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.DeleteQueryGroupRequest;
 import org.opensearch.rest.BaseRestHandler;
 import org.opensearch.rest.RestRequest;
 import org.opensearch.rest.action.RestToXContentListener;

diff --git a/...gin/wlm/rest/RestGetQueryGroupAction.java → ...rygroup/rest/RestGetQueryGroupAction.java b/...gin/wlm/rest/RestGetQueryGroupAction.java → ...rygroup/rest/RestGetQueryGroupAction.java
@@ -6,14 +6,14 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.rest;
+package org.opensearch.plugin.wlm.querygroup.rest;
 
 import org.opensearch.client.node.NodeClient;
 import org.opensearch.core.rest.RestStatus;
 import org.opensearch.core.xcontent.ToXContent;
-import org.opensearch.plugin.wlm.action.GetQueryGroupAction;
-import org.opensearch.plugin.wlm.action.GetQueryGroupRequest;
-import org.opensearch.plugin.wlm.action.GetQueryGroupResponse;
+import org.opensearch.plugin.wlm.querygroup.action.GetQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.GetQueryGroupRequest;
+import org.opensearch.plugin.wlm.querygroup.action.GetQueryGroupResponse;
 import org.opensearch.rest.BaseRestHandler;
 import org.opensearch.rest.BytesRestResponse;
 import org.opensearch.rest.RestChannel;

diff --git a/.../wlm/rest/RestUpdateQueryGroupAction.java → ...roup/rest/RestUpdateQueryGroupAction.java b/.../wlm/rest/RestUpdateQueryGroupAction.java → ...roup/rest/RestUpdateQueryGroupAction.java
@@ -6,15 +6,15 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.rest;
+package org.opensearch.plugin.wlm.querygroup.rest;
 
 import org.opensearch.client.node.NodeClient;
 import org.opensearch.core.rest.RestStatus;
 import org.opensearch.core.xcontent.ToXContent;
 import org.opensearch.core.xcontent.XContentParser;
-import org.opensearch.plugin.wlm.action.UpdateQueryGroupAction;
-import org.opensearch.plugin.wlm.action.UpdateQueryGroupRequest;
-import org.opensearch.plugin.wlm.action.UpdateQueryGroupResponse;
+import org.opensearch.plugin.wlm.querygroup.action.UpdateQueryGroupAction;
+import org.opensearch.plugin.wlm.querygroup.action.UpdateQueryGroupRequest;
+import org.opensearch.plugin.wlm.querygroup.action.UpdateQueryGroupResponse;
 import org.opensearch.rest.BaseRestHandler;
 import org.opensearch.rest.BytesRestResponse;
 import org.opensearch.rest.RestChannel;

diff --git a/...load-management/src/main/java/org/opensearch/plugin/wlm/querygroup/rest/package-info.java b/...load-management/src/main/java/org/opensearch/plugin/wlm/querygroup/rest/package-info.java
@@ -0,0 +1,12 @@
+/*
+ * 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 for the rest classes related to query groups in WorkloadManagementPlugin
+ */
+package org.opensearch.plugin.wlm.querygroup.rest;
diff --git a/...service/QueryGroupPersistenceService.java → ...service/QueryGroupPersistenceService.java b/...service/QueryGroupPersistenceService.java → ...service/QueryGroupPersistenceService.java
@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.plugin.wlm.service;
+package org.opensearch.plugin.wlm.querygroup.service;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -27,10 +27,10 @@
 import org.opensearch.common.settings.Settings;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.rest.RestStatus;
-import org.opensearch.plugin.wlm.action.CreateQueryGroupResponse;
-import org.opensearch.plugin.wlm.action.DeleteQueryGroupRequest;
-import org.opensearch.plugin.wlm.action.UpdateQueryGroupRequest;
-import org.opensearch.plugin.wlm.action.UpdateQueryGroupResponse;
+import org.opensearch.plugin.wlm.querygroup.action.CreateQueryGroupResponse;
+import org.opensearch.plugin.wlm.querygroup.action.DeleteQueryGroupRequest;
+import org.opensearch.plugin.wlm.querygroup.action.UpdateQueryGroupRequest;
+import org.opensearch.plugin.wlm.querygroup.action.UpdateQueryGroupResponse;
 import org.opensearch.wlm.MutableQueryGroupFragment;
 import org.opensearch.wlm.ResourceType;
 

diff --git a/...d-management/src/main/java/org/opensearch/plugin/wlm/querygroup/service/package-info.java b/...d-management/src/main/java/org/opensearch/plugin/wlm/querygroup/service/package-info.java
@@ -0,0 +1,12 @@
+/*
+ * 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 for the service classes related to query groups in WorkloadManagementPlugin
+ */
+package org.opensearch.plugin.wlm.querygroup.service;