Primary setup for Multi-tenancy (opensearch-project#3307)

* multi-tenancy primary setup

Signed-off-by: Dhrubo Saha <[email protected]>

* addressed comments

Signed-off-by: Dhrubo Saha <[email protected]>

* addressed comments + fixed dependency issue

Signed-off-by: Dhrubo Saha <[email protected]>

* adding more log to debug the testVisualizationFound issue

Signed-off-by: Dhrubo Saha <[email protected]>

* changing back

Signed-off-by: Dhrubo Saha <[email protected]>

---------

Signed-off-by: Dhrubo Saha <[email protected]>

Author: dhrubo-os

.github/workflows/CI-workflow.yml

@@ -52,7 +52,6 @@ jobs:
         with:
           role-to-assume: ${{ secrets.ML_ROLE }}
           aws-region: us-west-2
-
       - name: Checkout MLCommons
         uses: actions/checkout@v4
         with:

common/src/main/java/org/opensearch/ml/common/CommonValue.java

@@ -21,6 +21,9 @@ public class CommonValue {
     public static final String UNDEPLOYED = "undeployed";
     public static final String NOT_FOUND = "not_found";
 
+    /** The field name containing the tenant id */
+    public static final String TENANT_ID_FIELD = "tenant_id";
+
     public static final String MASTER_KEY = "master_key";
     public static final String CREATE_TIME_FIELD = "create_time";
     public static final String LAST_UPDATE_TIME_FIELD = "last_update_time";
@@ -63,4 +66,5 @@ public class CommonValue {
     public static final Version VERSION_2_16_0 = Version.fromString("2.16.0");
     public static final Version VERSION_2_17_0 = Version.fromString("2.17.0");
     public static final Version VERSION_2_18_0 = Version.fromString("2.18.0");
+    public static final Version VERSION_2_19_0 = Version.fromString("2.19.0");
 }

common/src/main/java/org/opensearch/ml/common/connector/AbstractConnector.java

@@ -71,6 +71,8 @@ public abstract class AbstractConnector implements Connector {
     protected Instant lastUpdateTime;
     @Setter
     protected ConnectorClientConfig connectorClientConfig;
+    @Setter
+    protected String tenantId;
 
     protected Map<String, String> createDecryptedHeaders(Map<String, String> headers) {
         if (headers == null) {

common/src/main/java/org/opensearch/ml/common/connector/Connector.java

@@ -43,6 +43,10 @@ public interface Connector extends ToXContentObject, Writeable {
 
     String getName();
 
+    String getTenantId();
+
+    void setTenantId(String tenantId);
+
     String getProtocol();
 
     void setCreatedTime(Instant createdTime);

common/src/main/java/org/opensearch/ml/common/input/Constants.java

@@ -36,4 +36,5 @@ public class Constants {
     public static final String AD_TRAINING_DATA_SIZE = "trainingDataSize";
     public static final String AD_ANOMALY_SCORE_THRESHOLD = "anomalyScoreThreshold";
     public static final String AD_DATE_FORMAT = "dateFormat";
+    public static final String TENANT_ID_HEADER = "x-tenant-id";
 }

common/src/main/java/org/opensearch/ml/common/settings/SettingsChangeListener.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensearch.ml.common.settings;
+
+/**
+ * Interface for handling settings changes in the OpenSearch ML plugin.
+ */
+public interface SettingsChangeListener {
+    /**
+     * Callback method that gets triggered when the multi-tenancy setting changes.
+     *
+     * @param isEnabled A boolean value indicating the new state of the multi-tenancy setting:
+     *                  <ul>
+     *                    <li><code>true</code> if multi-tenancy is enabled</li>
+     *                    <li><code>false</code> if multi-tenancy is disabled</li>
+     *                  </ul>
+     */
+    void onMultiTenancyEnabledChanged(boolean isEnabled);
+}

common/src/main/java/org/opensearch/ml/common/transport/connector/MLConnectorGetRequest.java

@@ -6,12 +6,14 @@
 package org.opensearch.ml.common.transport.connector;
 
 import static org.opensearch.action.ValidateActions.addValidationError;
+import static org.opensearch.ml.common.CommonValue.VERSION_2_19_0;
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.UncheckedIOException;
 
+import org.opensearch.Version;
 import org.opensearch.action.ActionRequest;
 import org.opensearch.action.ActionRequestValidationException;
 import org.opensearch.core.common.io.stream.InputStreamStreamInput;
@@ -26,24 +28,34 @@
 public class MLConnectorGetRequest extends ActionRequest {
 
     String connectorId;
+    String tenantId;
     boolean returnContent;
 
     @Builder
-    public MLConnectorGetRequest(String connectorId, boolean returnContent) {
+    public MLConnectorGetRequest(String connectorId, String tenantId, boolean returnContent) {
         this.connectorId = connectorId;
+        this.tenantId = tenantId;
         this.returnContent = returnContent;
     }
 
     public MLConnectorGetRequest(StreamInput in) throws IOException {
         super(in);
+        Version streamInputVersion = in.getVersion();
         this.connectorId = in.readString();
+        if (streamInputVersion.onOrAfter(VERSION_2_19_0)) {
+            this.tenantId = in.readOptionalString();
+        }
         this.returnContent = in.readBoolean();
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
         super.writeTo(out);
+        Version streamOutputVersion = out.getVersion();
         out.writeString(this.connectorId);
+        if (streamOutputVersion.onOrAfter(VERSION_2_19_0)) {
+            out.writeOptionalString(this.tenantId);
+        }
         out.writeBoolean(returnContent);
     }
 

common/src/main/resources/index-mappings/ml_agent.json

@@ -1,6 +1,6 @@
 {
   "_meta": {
-    "schema_version": 2
+    "schema_version": 3
   },
   "properties": {
     "name": {
@@ -33,6 +33,9 @@
     "is_hidden": {
       "type": "boolean"
     },
+    "tenant_id": {
+      "type": "keyword"
+    },
     "created_time": {
       "type": "date",
       "format": "strict_date_time||epoch_millis"

common/src/main/resources/index-mappings/ml_config.json

@@ -1,6 +1,6 @@
 {
   "_meta": {
-    "schema_version": 4
+    "schema_version": 5
   },
   "properties": {
     "master_key": {
@@ -9,6 +9,9 @@
     "config_type": {
       "type": "keyword"
     },
+    "tenant_id": {
+      "type": "keyword"
+    },
     "ml_configuration": {
       "type": "flat_object"
     },

common/src/main/resources/index-mappings/ml_connector.json

@@ -1,6 +1,6 @@
 {
   "_meta": {
-    "schema_version": 3
+    "schema_version": 4
   },
   "properties": {
     "name": {
@@ -30,6 +30,9 @@
     "client_config": {
       "type": "flat_object"
     },
+    "tenant_id": {
+      "type": "keyword"
+    },
     "actions": {
       "type": "flat_object"
     },