命令行工具 gsctl

gsctl 是 GraphScope 的命令行工具。它提供了一系列功能,使 GraphScope 更易于使用。这些功能包括构建镜像和软件包、管理会话和资源等。

安装/更新 gsctl

$ pip3 install gsctl
# or force reinstall gsctl by:
$ pip3 install gsctl --force-reinstall -U

在某些情况下,例如开发gsctl时,您可能需要从源代码构建它。 为此,请导航到源代码所在的目录并运行以下命令:

$ cd ${REPO_HOME}
# If you want to develop gsctl,
# please note the entry point is located on /python/graphscope/gsctl/gsctl.py
$ make gsctl

这将以可编辑模式安装gsctl,这意味着您对源代码所做的任何更改都会反映在已安装的gsctl版本中。

命令

通过gsctl,您可以执行以下操作。请始终记得在命令中使用--help以获取更多信息。

gsctl 命令行工具支持两种操作模式:实用脚本模式和客户端/服务器模式。您可以使用 gsctl connectgsctl close 命令在这些模式之间切换。

实用脚本

默认情况下,gsctl提供了可以通过单独使用gsctl运行的辅助功能和实用工具。gsctl作为GraphScope的命令行入口点。一些实用脚本示例如下:

  • gsctl install-deps,安装构建GraphScope所需的依赖项。

  • gsctl connect,使用配置文件~/.gsctl连接到已启动的coordinator。

  • gsctl close, 关闭与协调器的连接。

  • gsctl flexbuild,为Interactive和Insight产品构建Docker镜像。

  • gsctl version, 打印客户端版本信息。

  • gsctl instance,部署或销毁一个GraphScope Flex实例。

客户端/服务器模式

要切换到客户端/服务器模式,请使用gsctl connect命令。默认情况下,该命令会使用位于${HOME}/.gsctl的配置文件将gsctl连接到已启动的协调器;如果指定了--coordinator-endpoint参数,则会将其视为当前上下文并覆盖配置文件。

连接后,您可以使用gsctl与协调器通信,该协调器服务于其背后的特定Flex产品。

变更范围

gsctl中,您可以在全局范围或局部范围内运行命令。当您连接到协调器时,您处于全局范围。要切换到图的局部范围,请运行gsctl use GRAPH 命令。您可以通过gsctl ls命令查找图标识符。

$ gsctl use GRAPH modern_graph
Using GRAPH modern_graph

要切换回全局作用域,请运行gsctl use GLOBAL命令。

$ gsctl use GLOBAL
Using GLOBAL

不同的作用域有不同的命令。请始终记得在命令上使用--help来获取更多信息。

关闭连接

要断开与协调器的连接并切换回实用脚本模式,您可以使用gsctl close命令。该命令会关闭与协调器的连接,使您能够再次将gsctl作为独立实用工具使用。

下一步是什么