feat(interactive): Support customizing coordinator configuration for interactive (#4474)

Support specifying configuration for coordinator when deploy
Interactive.

Author: zhanglei1949

.github/workflows/flex-interactive.yml

@@ -41,6 +41,12 @@ jobs:
         python3 -m pip install --upgrade pip && python3 -m pip install click
         python3 ./gsctl.py flexbuild interactive --app docker
 
+    - name: Prepare dataset
+      env:
+        GS_TEST_DIR: /tmp/gstest
+      run: |
+        git clone -b master --single-branch --depth=1 https://github.com/GraphScope/gstest.git ${GS_TEST_DIR}
+
     - name: Build gsctl Wheel Package
       run: |
         cd ${GITHUB_WORKSPACE}/python
@@ -49,6 +55,8 @@ jobs:
         python3 setup_flex.py bdist_wheel
         python3 setup_gsctl.py bdist_wheel
 
+        python3 -m pip install ${GITHUB_WORKSPACE}/python/dist/*.whl
+
     - name: Setup tmate session
       uses: mxschmitt/action-tmate@v3
       if: false
@@ -59,10 +67,9 @@ jobs:
         COORDINATOR_PORT: 8080
         COORDINATOR_ENDPOINT: "http://127.0.0.1:8080"
       run: |
-        # install gsctl
-        python3 -m pip install ${GITHUB_WORKSPACE}/python/dist/*.whl
         # launch service: ${COORDINATOR_PORT} for coordinator http port; ${CYPHER_PORT} for cypher port;
-        gsctl instance deploy --type interactive --image-registry graphscope --image-tag latest --cypher-port ${CYPHER_PORT} --coordinator-port ${COORDINATOR_PORT} --interactive-config ${GITHUB_WORKSPACE}/flex/tests/hqps/interactive_config_test.yaml
+        gsctl instance deploy --type interactive --image-registry graphscope --image-tag latest --cypher-port ${CYPHER_PORT} \
+              --coordinator-port ${COORDINATOR_PORT} --config ${GITHUB_WORKSPACE}/flex/tests/hqps/interactive_config_test.yaml
         sleep 20
         # test
         python3 -m pip install --no-cache-dir pytest pytest-cov pytest-timeout pytest-xdist
@@ -79,6 +86,33 @@ jobs:
         # destroy instance
         gsctl instance destroy --type interactive -y
 
+    - name: Test customizing coordinator config
+      env:
+        CYPHER_PORT: 7688
+        COORDINATOR_PORT: 8080
+        COORDINATOR_ENDPOINT: "http://127.0.0.1:8080"
+        GS_TEST_DIR: /tmp/gstest
+      run: |
+        # launch service: ${COORDINATOR_PORT} for coordinator http port; ${CYPHER_PORT} for cypher port;
+        cat >>  ${GITHUB_WORKSPACE}/flex/tests/hqps/interactive_config_test.yaml << EOF
+        coordinator:
+          max_content_length: 1048576 # 1MB
+        EOF
+        gsctl instance deploy --type interactive --image-registry graphscope --image-tag latest --cypher-port ${CYPHER_PORT} \
+              --coordinator-port ${COORDINATOR_PORT} --config ${GITHUB_WORKSPACE}/flex/tests/hqps/interactive_config_test.yaml \
+              --admin-port 7778 --storedproc-port 10001
+        sleep 20
+        # test
+        python3 -m pip install --no-cache-dir pytest pytest-cov pytest-timeout pytest-xdist
+        python3 -m pytest -d --tx popen//python=python3 \
+                          -s -v \
+                          --cov=graphscope --cov-config=${GITHUB_WORKSPACE}/python/.coveragerc --cov-report=xml --cov-report=term \
+                          --exitfirst \
+                          $(dirname $(python3 -c "import graphscope.gsctl as gsctl; print(gsctl.__file__)"))/tests/test_file_uploading.py
+
+        # destroy instance
+        gsctl instance destroy --type interactive -y
+
     - name: Test basic examples
       run: |
         # build gs_interactive wheel package
@@ -87,7 +121,7 @@ jobs:
         cd python && pip3 install -r requirements.txt && python3 setup.py build_proto
         python3 setup.py bdist_wheel
         pip3 install dist/*.whl
-        gsctl instance deploy --type interactive --image-registry graphscope --image-tag latest --interactive-config ${GITHUB_WORKSPACE}/flex/tests/hqps/interactive_config_test.yaml
+        gsctl instance deploy --type interactive --image-registry graphscope --image-tag latest --config ${GITHUB_WORKSPACE}/flex/tests/hqps/interactive_config_test.yaml
         sleep 20
         # test
         cd ${GITHUB_WORKSPACE}/flex/interactive/sdk/examples/python

docs/flex/interactive/configuration.md

@@ -15,7 +15,7 @@ Below is a list of all configurable items:
 | admin-port       | 7777    | The port of the interactive admin service       | v0.3          |
 | storedproc-port   | 10000    | The port of the interactive stored procedure service      | v0.3          |
 | cypher-port       | 7687    | The port of the cypher service       | v0.3          |
-| config             | None    | The customized configuration file for engine interactive service | v0.4   |
+| config | None    | The customized configuration file for engine interactive service | v0.4   |
 <!-- | gremlin-port       | None    | The port of the gremlin service       | v0.3          | -->
 
 
@@ -50,7 +50,7 @@ By default, `Interactive` will initialize the service with its default settings.
 However, GraphScope Interactive is designed to be flexible and adaptable to your specific needs. This means you can tailor the service's behavior using custom configurations.
 
 
-#### Customizing Your Service Configuration
+#### Customizing Interactive Engine Service Configuration
 To customize the service's settings, you can provide a YAML configuration file `interactive_config.yaml`. This file allows you to specify various parameters, from directory paths to log levels, ensuring the service aligns with your requirements. To use a custom configuration, simply pass the YAML file to the command as follows:
 
 ```bash
@@ -61,6 +61,19 @@ gsctl instance deploy --type interactive --config ./interactive_config.yaml
 Please be aware that you're not required to configure every option. Simply adjust the settings that are relevant to your needs. Any options left unconfigured will automatically adopt their default values, as detailed in the following sections.
 ```
 
+#### Customize Coordinator Service Configuration
+
+When deploying Interactive, a supplementary service called the Coordinator is also initiated. This service functions similarly to the `ApiServer` in Kubernetes, providing users with a consistent and standardized set of APIs to interact with the GraphScope platform.
+You could also customize the configuration for coordinator service, just put the configuration in `coordinator` section.
+
+An example of a coordinator related configuration is as follows:
+
+```yaml
+coordinator:
+  max_content_length: 5242880 # maximum bytes of content the coordinator can handle
+```
+
+For more details, consult [config.py](https://github.com/alibaba/GraphScope/blob/main/python/graphscope/config.py).
 
 
 ##### Sample Configuration
@@ -121,6 +134,7 @@ In this following table, we use the `.` notation to represent the hierarchy with
 | compiler.planner.rules.NotMatchToAntiJoinRule | N/A | An optimization rule that transforms a "not exist" pattern into an anti-join operation  | 0.0.1 |
 | compiler.query_timeout  | 3000000   ｜ The maximum time for compiler to wait engine's reply, in `ms`  | 0.0.3 | 
 | http_service.sharding_mode | exclusive | The sharding mode for http service, In exclusive mode, one shard is reserved exclusively for service admin request. In cooperative, both query request and admin request could be served by any shard. | 0.5 |
+| coordinator.max_content_length | 1073741824 | The maximum length of a http request that coordinator could handle | 0.5 |
 
 #### TODOs
 

flex/tests/hqps/interactive_config_test.yaml

@@ -41,3 +41,5 @@ http_service:
   default_listen_address: localhost
   admin_port: 7777
   query_port: 10000
+coordinator:
+  max_content_length: 1048576 # 1MB

k8s/dockerfiles/interactive-entrypoint.sh

@@ -18,6 +18,7 @@ set -e
 DEFAULT_GRAPH_NAME=gs_interactive_default_graph
 BULK_LOADER_BINARY_PATH=/opt/flex/bin/bulk_loader
 INTERACTIVE_SERVER_BIN=/opt/flex/bin/interactive_server
+DEFAULT_INTERACTIVE_CONFIG_FILE=/opt/flex/share/interactive_config.yaml
 
 function usage() {
     cat << EOF
@@ -54,7 +55,7 @@ function prepare_workspace() {
     fi
     # prepare interactive_config.yaml
     engine_config_path="${workspace}/conf/interactive_config.yaml"
-    cp /opt/flex/share/interactive_config.yaml $engine_config_path
+    cp ${DEFAULT_INTERACTIVE_CONFIG_FILE} $engine_config_path
     #make sure the line which start with default_graph is changed to default_graph: ${DEFAULT_GRAPH_NAME}
     sed -i "s/default_graph:.*/default_graph: ${DEFAULT_GRAPH_NAME}/" $engine_config_path
     # By default, we occupy the all available cpus
@@ -96,6 +97,10 @@ function launch_service() {
 }
 
 function launch_coordinator() {
+  if [ $# -ne 1 ]; then
+    echo "Usage: launch_coordinator <port_mapping>"
+    exit 1
+  fi
   local host_ports=()
   local container_ports=()
   if [ -n "$1" ]; then
@@ -108,30 +113,34 @@ function launch_coordinator() {
   fi
   if $ENABLE_COORDINATOR;
   then
-    coordinator_config_file="/tmp/coordinator-config.yaml"
-    cat > $coordinator_config_file << EOF
-coordinator:
-  http_port: 8080
-
-launcher_type: hosts
-
+    dst_coordinator_config_file="/tmp/coordinator_config_$(date +%s).yaml"
+    cat > $dst_coordinator_config_file << EOF
 session:
   instance_id: demo
+launcher_type: hosts
+coordinator:
+  http_port: 8080
 EOF
+    python3 -m pip install pyyaml
+    res=$(python3 -c "import yaml; config = yaml.safe_load(open('${DEFAULT_INTERACTIVE_CONFIG_FILE}')); print(yaml.dump(config.get('coordinator', {}), default_flow_style=False, indent=4))")
+    # for each line in res, echo to dst_coordinator_config_file with 2 spaces indentation
+    while IFS= read -r line; do
+      echo "  $line" >> $dst_coordinator_config_file
+    done <<< "$res"
 
     if [ ${#host_ports[@]} -gt 0 ]; then
-      echo "interactive:" >> $coordinator_config_file
-      echo "  port_mapping:" >> $coordinator_config_file
+      echo "interactive:" >> $dst_coordinator_config_file
+      echo "  port_mapping:" >> $dst_coordinator_config_file
       for i in "${!host_ports[@]}"; do
-        echo "    ${container_ports[$i]}: ${host_ports[$i]}" >> $coordinator_config_file
+        echo "    ${container_ports[$i]}: ${host_ports[$i]}" >> $dst_coordinator_config_file
       done
     fi
     # i.e
     # interactive:
     #   port_mapping:
     #     8080: 8081
     #     7777: 7778
-    python3 -m gscoordinator --config-file $coordinator_config_file
+    python3 -m gscoordinator --config-file $dst_coordinator_config_file
   fi
 }
 
@@ -179,4 +188,5 @@ done
 
 prepare_workspace $WORKSPACE
 launch_service $WORKSPACE
+# Note that the COORDINATOR_CONFIG_FILE should be inside the container
 launch_coordinator $PORT_MAPPING

python/graphscope/gsctl/commands/dev.py

@@ -42,7 +42,8 @@
 # Interactive docker container config
 INTERACTIVE_DOCKER_CONTAINER_NAME = "gs-interactive-instance"
 INTERACTIVE_DOCKER_CONTAINER_LABEL = "flex=interactive"
-INTERACTIVE_DOCKER_DEFAULT_CONFIG_PATH = "/opt/flex/share/interactive_config.yaml"
+INTERACTIVE_DOCKER_DEFAULT_CONFIG_PATH = "/opt/flex/share/config.yaml"
+COORDINATOR_DOCKER_DEFAULT_CONFIG_PATH = "/opt/flex/share/coordinator_config.yaml"
 
 scripts_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "scripts")
 install_deps_script = os.path.join(scripts_dir, "install_deps.sh")
@@ -191,7 +192,7 @@ def interactive(app, graphscope_repo, version):
     required=False,
 )
 @click.option(
-    "--interactive-config",
+    "--config",
     help="Interactive config file path [docker only]",
     required=False,
     default=None,
@@ -234,7 +235,7 @@ def deploy(
     storedproc_port,
     cypher_port,
     gremlin_port,
-    interactive_config,
+    config,
 ):  # noqa: F811
     """Deploy a GraphScope Flex instance"""
     cmd = []
@@ -258,17 +259,15 @@ def deploy(
         ]
         if gremlin_port != -1:
             cmd.extend(["-p", f"{gremlin_port}:8182"])
-        if interactive_config is not None:
-            if not os.path.isfile(interactive_config):
+        if config is not None:
+            if not os.path.isfile(config):
                 click.secho(
-                    f"Interactive config file {interactive_config} does not exist.",
+                    f"Interactive config file {config} does not exist.",
                     fg="red",
                 )
                 return
-            interactive_config = os.path.abspath(interactive_config)
-            cmd.extend(
-                ["-v", f"{interactive_config}:{INTERACTIVE_DOCKER_DEFAULT_CONFIG_PATH}"]
-            )
+            config = os.path.abspath(config)
+            cmd.extend(["-v", f"{config}:{INTERACTIVE_DOCKER_DEFAULT_CONFIG_PATH}"])
         image = f"{image_registry}/{type}:{image_tag}"
         cmd.extend([image, "--enable-coordinator"])
         cmd.extend(

python/graphscope/gsctl/tests/test_file_uploading.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2020 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# Licensed 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.
+#
+
+import os
+import warnings
+
+# Disable warnings
+warnings.filterwarnings("ignore", category=Warning)
+
+import time
+
+import pytest
+
+from graphscope.gsctl.impl import connect_coordinator
+from graphscope.gsctl.impl import disconnect_coordinator
+from graphscope.gsctl.impl import upload_file
+
+COORDINATOR_ENDPOINT = "http://127.0.0.1:8080"
+
+
+class TestFileUploading(object):
+    def setup_class(self):
+        if "COORDINATOR_ENDPOINT" in os.environ:
+            COORDINATOR_ENDPOINT = os.environ["COORDINATOR_ENDPOINT"]
+        self.deployment_info = connect_coordinator(COORDINATOR_ENDPOINT)
+
+    def test_upload_file(self):
+        """
+        This test assumes that coordinator.max_content_length is set to less than 2MB.
+        """
+        gs_test_dir = os.environ.get("GS_TEST_DIR")
+        if gs_test_dir is None:
+            raise ValueError("GS_TEST_DIR is not set.")
+        upload_file(gs_test_dir + "/modern_graph/person.csv")
+
+        with pytest.raises(Exception):
+            upload_file(gs_test_dir + "/modern_graph/person_not_exist.csv")
+
+        with pytest.raises(Exception):
+            upload_file(
+                gs_test_dir + "/flex/ldbc-sf01-long-date/post_hasCreator_person_0_0.csv"
+            )
+
+    def teardown_class(self):
+        disconnect_coordinator()