feat(interactive): Update document and build latest Interactive image. (#4501)

zhanglei1949 · web-flow · commit 460667e7b681 · 2025-02-21T10:22:28.000+08:00
- Let `gsctl` use the latest interactive image.
- Allow overriding configuration in config via command line argument:
`--set a=b`
diff --git a/.github/workflows/flex-interactive.yml b/.github/workflows/flex-interactive.yml
@@ -70,7 +70,8 @@ jobs:
         docker image inspect graphscope/interactive:latest --format='{{.Size}}'
         # 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} --config ${GITHUB_WORKSPACE}/flex/tests/hqps/interactive_config_test.yaml
+              --coordinator-port ${COORDINATOR_PORT} --config ${GITHUB_WORKSPACE}/flex/tests/hqps/interactive_config_test.yaml \
+              --set storage.string_default_max_length=1024
         sleep 20
         # test
         python3 -m pip install --no-cache-dir pytest pytest-cov pytest-timeout pytest-xdist
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -158,6 +158,61 @@ jobs:
         sudo docker tag graphscope/interactive:${SHORT_SHA} ${{ env.INTERACTIVE_IMAGE }}:${{ steps.tag.outputs.TAG }}-arm64
         sudo docker push ${{ env.INTERACTIVE_IMAGE }}:${{ steps.tag.outputs.TAG }}-arm64
 
+  push-interactive-image-manifest:
+    if: (github.ref == 'refs/heads/main' && github.repository == 'alibaba/GraphScope') || (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'alibaba/GraphScope')
+    runs-on: ubuntu-22.04
+
+    needs: [build-interactive-image-amd64, build-interactive-image-arm64]
+
+    - name: Add envs to GITHUB_ENV
+      run: |
+        short_sha=$(git rev-parse --short HEAD)
+        echo "SHORT_SHA=${short_sha}" >> $GITHUB_ENV
+
+    - name: Create and Push Docker Manifest
+      env:
+        docker_password: ${{ secrets.DOCKER_PASSWORD }}
+        docker_username: ${{ secrets.DOCKER_USER }}
+      run: |
+        echo "${docker_password}" | sudo docker login --username="${docker_username}" ${{ env.DOCKER_URL }} --password-stdin
+
+        # create
+        sudo docker manifest create \
+          ${{ env.INTERACTIVE_IMAGE }}:${SHORT_SHA} \
+          ${{ env.INTERACTIVE_IMAGE }}:${SHORT_SHA}-amd64 \
+          ${{ env.INTERACTIVE_IMAGE }}:${SHORT_SHA}-arm64
+
+        # push
+        sudo docker manifest push ${{ env.INTERACTIVE_IMAGE }}:${SHORT_SHA}
+
+        # Remove old latest manifest
+        sudo docker manifest rm ${{ env.INTERACTIVE_IMAGE }}:latest
+        sudo docker manifest create \
+          ${{ env.INTERACTIVE_IMAGE }}:latest \
+          ${{ env.INTERACTIVE_IMAGE }}:latest-amd64 \
+          ${{ env.INTERACTIVE_IMAGE }}:latest-arm64
+
+        sudo docker manifest push ${{ env.INTERACTIVE_IMAGE }}:latest
+
+    - name: Extract Tag Name
+      if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'alibaba/GraphScope' }}
+      id: tag
+      run: echo "TAG=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+
+    - name: Release Image
+      if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'alibaba/GraphScope' }}
+      env:
+        docker_password: ${{ secrets.DOCKER_PASSWORD }}
+        docker_username: ${{ secrets.DOCKER_USER }}
+      run: |
+        echo "${docker_password}" | sudo docker login --username="${docker_username}" ${{ env.DOCKER_URL }} --password-stdin
+        sudo docker manifest create \
+          ${{ env.INTERACTIVE_IMAGE }}:${{ steps.tag.outputs.TAG }} \
+          ${{ env.INTERACTIVE_IMAGE }}:${{ steps.tag.outputs.TAG }}-amd64 \
+          ${{ env.INTERACTIVE_IMAGE }}:${{ steps.tag.outputs.TAG }}-arm64
+
+        sudo docker manifest push ${{ env.INTERACTIVE_IMAGE }}:${{ steps.tag.outputs.TAG }}
+
   build-gss-image-amd64:
     if: (github.ref == 'refs/heads/main' && github.repository == 'alibaba/GraphScope') || (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'alibaba/GraphScope')
     runs-on: ubuntu-20.04
diff --git a/docs/flex/interactive/configuration.md b/docs/flex/interactive/configuration.md
@@ -16,6 +16,8 @@ Below is a list of all configurable items:
 | 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   |
+| image-tag       | latest    | The version of the interactive you want to install | v0.5 |
+| set             | None      | Specify additional properties for Interactive via the command line to override any corresponding settings in the configuration file if they are present | v0.5 |
 <!-- | gremlin-port       | None    | The port of the gremlin service       | v0.3          | -->
 
 
@@ -121,6 +123,7 @@ In this following table, we use the `.` notation to represent the hierarchy with
 | 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 |
 | http_service.max_content_length | 1GB | The maximum length of a http request that admin http service could handle | 0.5 |
+| storage.string_default_max_length | 256 | The default maximum size for a string field | 0.5 |
 
 #### TODOs
 
diff --git a/docs/flex/interactive/installation.md b/docs/flex/interactive/installation.md
@@ -25,6 +25,10 @@ gsctl instance deploy --type interactive
 In addition to the interactive server, a coordinator server is also deployed. The coordinator server functions similarly to the `ApiServer` for k8s, enabling users to engage with the GraphScope platform via a streamlined and standardized set of APIs.
 ```
 
+```{note}
+By default, the latest version of Interactive is used. To specify a fixed version, use the --image-tag option. For example `gsctl instance deploy --type interactive --image-tag v0.31.0`.
+```
+
 <!-- 2. Gremlin service is disabled by default, To enable it, try specifying the Gremlin port, see [Service-Accessibility](./installation.md#service-accessibility) -->
 
 
diff --git a/flex/storages/rt_mutable_graph/loader/abstract_arrow_fragment_loader.cc b/flex/storages/rt_mutable_graph/loader/abstract_arrow_fragment_loader.cc
@@ -395,8 +395,8 @@ void AbstractArrowFragmentLoader::AddEdgesRecordBatch(
                property_types[0].type_enum ==
                    impl::PropertyTypeImpl::kStringView) {
       // Both varchar and string are treated as string. For String, we use the
-      // default max length defined in PropertyType::STRING_DEFAULT_MAX_LENGTH
-      uint16_t max_length = PropertyType::STRING_DEFAULT_MAX_LENGTH;
+      // default max length defined in PropertyType::GetStringDefaultMaxLength()
+      uint16_t max_length = PropertyType::GetStringDefaultMaxLength();
       if (property_types[0].type_enum == impl::PropertyTypeImpl::kVarChar) {
         max_length = property_types[0].additional_type_info.max_length;
       }
diff --git a/flex/storages/rt_mutable_graph/loader/basic_fragment_loader.h b/flex/storages/rt_mutable_graph/loader/basic_fragment_loader.h
@@ -122,7 +122,7 @@ class BasicFragmentLoader {
       const auto& prop = schema_.get_edge_properties(src_label_id, dst_label_id,
                                                      edge_label_id);
 
-      size_t max_length = PropertyType::STRING_DEFAULT_MAX_LENGTH;
+      size_t max_length = PropertyType::GetStringDefaultMaxLength();
       if (prop[0].IsVarchar()) {
         max_length = prop[0].additional_type_info.max_length;
       }
diff --git a/flex/storages/rt_mutable_graph/mutable_property_fragment.cc b/flex/storages/rt_mutable_graph/mutable_property_fragment.cc
@@ -104,7 +104,7 @@ inline DualCsrBase* create_csr(EdgeStrategy oes, EdgeStrategy ies,
           ie_mutable);
     } else if (properties[0] == PropertyType::kStringView) {
       return new DualCsr<std::string_view>(
-          oes, ies, gs::PropertyType::STRING_DEFAULT_MAX_LENGTH, oe_mutable,
+          oes, ies, gs::PropertyType::GetStringDefaultMaxLength(), oe_mutable,
           ie_mutable);
     }
   } else {
diff --git a/flex/storages/rt_mutable_graph/schema.h b/flex/storages/rt_mutable_graph/schema.h
@@ -46,7 +46,6 @@ class Schema {
   static constexpr const char* PRIMITIVE_TYPE_KEY = "primitive_type";
   static constexpr const char* VARCHAR_KEY = "varchar";
   static constexpr const char* MAX_LENGTH_KEY = "max_length";
-  static constexpr const uint16_t STRING_DEFAULT_MAX_LENGTH = 256;
 
   // The builtin plugins are reserved for the system.
   static constexpr uint8_t BUILTIN_PLUGIN_NUM = 4;
diff --git a/flex/utils/id_indexer.h b/flex/utils/id_indexer.h
@@ -242,10 +242,10 @@ class LFIndexer {
     } else if (type.type_enum == impl::PropertyTypeImpl::kStringView) {
       LOG(WARNING) << "String type is a deprecated type, use varchar instead.";
       LOG(WARNING) << "Use default max length"
-                   << PropertyType::STRING_DEFAULT_MAX_LENGTH
+                   << PropertyType::GetStringDefaultMaxLength()
                    << " for varchar type.";
       keys_ = new StringColumn(StorageStrategy::kMem,
-                               PropertyType::STRING_DEFAULT_MAX_LENGTH);
+                               PropertyType::GetStringDefaultMaxLength());
     } else {
       LOG(FATAL) << "Not support type [" << type << "] as pk type ..";
     }
diff --git a/flex/utils/property/column.cc b/flex/utils/property/column.cc
@@ -91,7 +91,7 @@ template <>
 class TypedEmptyColumn<std::string_view> : public ColumnBase {
  public:
   TypedEmptyColumn(
-      int32_t max_length = PropertyType::STRING_DEFAULT_MAX_LENGTH) {}
+      int32_t max_length = PropertyType::GetStringDefaultMaxLength()) {}
   ~TypedEmptyColumn() {}
 
   void open(const std::string& name, const std::string& snapshot_dir,
@@ -164,7 +164,7 @@ std::shared_ptr<ColumnBase> CreateColumn(
       return std::make_shared<StringEmptyColumn>();
     } else if (type == PropertyType::kStringView) {
       return std::make_shared<StringEmptyColumn>(
-          gs::PropertyType::STRING_DEFAULT_MAX_LENGTH);
+          gs::PropertyType::GetStringDefaultMaxLength());
     } else if (type.type_enum == impl::PropertyTypeImpl::kVarChar) {
       return std::make_shared<StringEmptyColumn>(
           type.additional_type_info.max_length);
diff --git a/flex/utils/property/column.h b/flex/utils/property/column.h
@@ -346,7 +346,7 @@ template <>
 class TypedColumn<std::string_view> : public ColumnBase {
  public:
   TypedColumn(StorageStrategy strategy,
-              uint16_t width = PropertyType::STRING_DEFAULT_MAX_LENGTH)
+              uint16_t width = PropertyType::GetStringDefaultMaxLength())
       : strategy_(strategy), width_(width) {}
   ~TypedColumn() { close(); }
 
@@ -598,7 +598,7 @@ class StringMapColumn : public ColumnBase {
       : index_col_(strategy), meta_map_(nullptr) {
     meta_map_ = new LFIndexer<INDEX_T>();
     meta_map_->init(
-        PropertyType::Varchar(PropertyType::STRING_DEFAULT_MAX_LENGTH));
+        PropertyType::Varchar(PropertyType::GetStringDefaultMaxLength()));
   }
 
   ~StringMapColumn() {
diff --git a/flex/utils/property/types.cc b/flex/utils/property/types.cc
@@ -64,8 +64,8 @@ PropertyType StringToPrimitivePropertyType(const std::string& str) {
   } else if (str == "Day" || str == DT_DAY || str == "day") {
     return PropertyType::kDay;
   } else if (str == "String" || str == "STRING" || str == DT_STRING) {
-    // DT_STRING is a alias for VARCHAR(STRING_DEFAULT_MAX_LENGTH);
-    return PropertyType::Varchar(PropertyType::STRING_DEFAULT_MAX_LENGTH);
+    // DT_STRING is a alias for VARCHAR(GetStringDefaultMaxLength());
+    return PropertyType::Varchar(PropertyType::GetStringDefaultMaxLength());
   } else if (str == DT_STRINGMAP) {
     return PropertyType::kStringMap;
   } else if (str == "Empty") {
@@ -84,6 +84,28 @@ PropertyType StringToPrimitivePropertyType(const std::string& str) {
 }
 }  // namespace config_parsing
 
+static uint16_t get_string_default_max_length_env() {
+  static uint16_t max_length = 0;
+  if (max_length == 0) {
+    char* env = std::getenv("FLEX_STRING_DEFAULT_MAX_LENGTH");
+    if (env) {
+      try {
+        max_length = static_cast<uint16_t>(std::stoi(env));
+        LOG(INFO) << "FLEX_STRING_DEFAULT_MAX_LENGTH: " << max_length;
+      } catch (std::exception& e) {
+        LOG(ERROR) << "Invalid FLEX_STRING_DEFAULT_MAX_LENGTH: " << env;
+      }
+    }
+  }
+  return max_length;
+}
+
+uint16_t PropertyType::GetStringDefaultMaxLength() {
+  return get_string_default_max_length_env() > 0
+             ? get_string_default_max_length_env()
+             : PropertyType::STRING_DEFAULT_MAX_LENGTH;
+}
+
 size_t RecordView::size() const { return table->col_num(); }
 
 Any RecordView::operator[](size_t col_id) const {
diff --git a/flex/utils/property/types.h b/flex/utils/property/types.h
@@ -93,7 +93,11 @@ union AdditionalTypeInfo {
 }  // namespace impl
 
 struct PropertyType {
+ private:
   static constexpr const uint16_t STRING_DEFAULT_MAX_LENGTH = 256;
+
+ public:
+  static uint16_t GetStringDefaultMaxLength();
   impl::PropertyTypeImpl type_enum;
   impl::AdditionalTypeInfo additional_type_info;
 
@@ -1428,7 +1432,7 @@ struct convert<gs::PropertyType> {
                 config["string"]["var_char"]["max_length"].as<int32_t>());
           } else {
             property_type = gs::PropertyType::Varchar(
-                gs::PropertyType::STRING_DEFAULT_MAX_LENGTH);
+                gs::PropertyType::GetStringDefaultMaxLength());
           }
         } else {
           LOG(ERROR) << "Unrecognized string type";
@@ -1455,7 +1459,7 @@ struct convert<gs::PropertyType> {
             config["varchar"]["max_length"].as<int32_t>());
       } else {
         property_type = gs::PropertyType::Varchar(
-            gs::PropertyType::STRING_DEFAULT_MAX_LENGTH);
+            gs::PropertyType::GetStringDefaultMaxLength());
       }
     } else if (config["date"]) {
       property_type = gs::PropertyType::Date();
diff --git a/flex/utils/pt_indexer.h b/flex/utils/pt_indexer.h
@@ -185,7 +185,7 @@ class PTIndexer {
                                type.additional_type_info.max_length);
     } else if (type == PropertyType::kStringView) {
       keys_ = new StringColumn(StorageStrategy::kMem,
-                               gs::PropertyType::STRING_DEFAULT_MAX_LENGTH);
+                               gs::PropertyType::GetStringDefaultMaxLength());
     } else {
       LOG(FATAL) << "Not support type [" << type << "] as pk type ..";
     }
diff --git a/flex/utils/service_utils.h b/flex/utils/service_utils.h
@@ -142,7 +142,7 @@ inline bool from_json(const rapidjson::Value& j, PropertyType& p) {
         p = PropertyType::Varchar(
             j["string"]["var_char"]["max_length"].GetInt());
       } else {
-        p = PropertyType::Varchar(PropertyType::STRING_DEFAULT_MAX_LENGTH);
+        p = PropertyType::Varchar(PropertyType::GetStringDefaultMaxLength());
       }
     } else {
       throw std::invalid_argument("Unknown string type: " +
diff --git a/python/graphscope/gsctl/commands/dev.py b/python/graphscope/gsctl/commands/dev.py
@@ -44,6 +44,11 @@
 INTERACTIVE_DOCKER_CONTAINER_LABEL = "flex=interactive"
 INTERACTIVE_DOCKER_DEFAULT_CONFIG_PATH = "/opt/flex/share/interactive_config.yaml"
 
+# additional configurations that could be set via command line --set, and will be passed to docker run command
+ADDITIONAL_ENVS = {
+    "storage.string_default_max_length": "FLEX_STRING_DEFAULT_MAX_LENGTH"
+}
+
 scripts_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "scripts")
 install_deps_script = os.path.join(scripts_dir, "install_deps.sh")
 default_graphscope_repo_path = os.path.join(
@@ -220,7 +225,14 @@ def interactive(app, graphscope_repo, version):
 @click.option(
     "--image-tag",
     help="Docker image tag used to launch instance",
-    default=__version__,
+    default="latest",
+    show_default=True,
+    required=False,
+)
+@click.option(
+    "--set",
+    help="Set additional environment variables for the instance",
+    default=None,
     show_default=True,
     required=False,
 )
@@ -235,6 +247,7 @@ def deploy(
     cypher_port,
     gremlin_port,
     config,
+    set,
 ):  # noqa: F811
     """Deploy a GraphScope Flex instance"""
     cmd = []
@@ -267,6 +280,14 @@ def deploy(
                 return
             config = os.path.abspath(config)
             cmd.extend(["-v", f"{config}:{INTERACTIVE_DOCKER_DEFAULT_CONFIG_PATH}"])
+        if set is not None:
+            for kv in set.split(","):
+                k, v = kv.split("=")
+                if k in ADDITIONAL_ENVS:
+                    cmd.extend(["-e", f"{ADDITIONAL_ENVS[k]}={v}"])
+                else:
+                    raise ValueError(f"Unknown configuration {k}")
+
         image = f"{image_registry}/{type}:{image_tag}"
         cmd.extend([image, "--enable-coordinator"])
         cmd.extend(

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ class BasicFragmentLoader {`
`122`	`122`	`const auto& prop = schema_.get_edge_properties(src_label_id, dst_label_id,`
`123`	`123`	`edge_label_id);`
`124`	`124`
`125`		`- size_t max_length = PropertyType::STRING_DEFAULT_MAX_LENGTH;`
	`125`	`+ size_t max_length = PropertyType::GetStringDefaultMaxLength();`
`126`	`126`	`if (prop[0].IsVarchar()) {`
`127`	`127`	`max_length = prop[0].additional_type_info.max_length;`
`128`	`128`	`}`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ inline DualCsrBase* create_csr(EdgeStrategy oes, EdgeStrategy ies,`
`104`	`104`	`ie_mutable);`
`105`	`105`	`} else if (properties[0] == PropertyType::kStringView) {`
`106`	`106`	`return new DualCsr<std::string_view>(`
`107`		`- oes, ies, gs::PropertyType::STRING_DEFAULT_MAX_LENGTH, oe_mutable,`
	`107`	`+ oes, ies, gs::PropertyType::GetStringDefaultMaxLength(), oe_mutable,`
`108`	`108`	`ie_mutable);`
`109`	`109`	`}`
`110`	`110`	`} else {`