管理员命令行工具

用法

bin/kyuubi-ctl --help

管理员 CLI

kyuubi 1.9.1
Usage: kyuubi-ctl [create|get|delete|list] [options]

  -zk, --zk-quorum <value>
                           The connection string for the zookeeper ensemble, using zk quorum manually.
  -n, --namespace <value>  The namespace, using kyuubi-defaults/conf if absent.
  -s, --host <value>       Hostname or IP address of a service.
  -p, --port <value>       Listening port of a service.
  -v, --version <value>    Using the compiled KYUUBI_VERSION default, change it if the active service is running in another.
  -b, --verbose            Print additional debug output.

Command: create [server]

Command: create server
        Expose Kyuubi server instance to another domain.

Command: get [server|engine] [options]
        Get the service/engine node info, host and port needed.
Command: get server
        Get Kyuubi server info of domain
Command: get engine
        Get Kyuubi engine info belong to a user.
  -u, --user <value>       The user name this engine belong to.
  -et, --engine-type <value>
                           The engine type this engine belong to.
  -es, --engine-subdomain <value>
                           The engine subdomain this engine belong to.
  -esl, --engine-share-level <value>
                           The engine share level this engine belong to.

Command: delete [server|engine] [options]
        Delete the specified service/engine node, host and port needed.
Command: delete server
        Delete the specified service node for a domain
Command: delete engine
        Delete the specified engine node for user.
  -u, --user <value>       The user name this engine belong to.
  -et, --engine-type <value>
                           The engine type this engine belong to.
  -es, --engine-subdomain <value>
                           The engine subdomain this engine belong to.
  -esl, --engine-share-level <value>
                           The engine share level this engine belong to.

Command: list [server|engine] [options]
        List all the service/engine nodes for a particular domain.
Command: list server
        List all the service nodes for a particular domain
Command: list engine
        List all the engine nodes for a user
  -u, --user <value>       The user name this engine belong to.
  -et, --engine-type <value>
                           The engine type this engine belong to.
  -es, --engine-subdomain <value>
                           The engine subdomain this engine belong to.
  -esl, --engine-share-level <value>
                           The engine share level this engine belong to.

  -h, --help               Show help message and exit.

管理 kyuubi 服务器

你可以指定 zookeeper 地址（--zk-quorum）和命名空间（--namespace）、版本（--version）等参数，以查询特定的 kyuubi 服务器集群。

列出服务器

列出特定域下的所有服务节点。

bin/kyuubi-ctl list server

创建服务器

将 Kyuubi 服务器实例暴露到另一个域。

首先读取 conf/kyuubi-defaults.conf 中的 kyuubi.ha.namespace，如果该命名空间下存在服务器实例，则将它们注册到 --namespace 参数指定的新命名空间中。

bin/kyuubi-ctl create server --namespace XXX

获取服务器

获取该域的 Kyuubi 服务器信息。

bin/kyuubi-ctl get server --host XXX --port YYY

删除服务节点

删除某个域下指定的服务节点。

服务节点被删除后，Kyuubi Server 将停止开启新会话，并等待所有当前已开启的会话关闭后，进程才会退出。

bin/kyuubi-ctl delete server --host XXX --port YYY

管理 Kyuubi 引擎

你还可以指定引擎类型（--engine-type）、引擎共享级别子域（--engine-subdomain）和引擎共享级别（--engine-share-level）。

如果未指定，则读取 kyuubi-defaults.conf 中的配置项 kyuubi.engine.type，默认值为 SPARK_SQL；kyuubi.engine.share.level.subdomain，默认值为 default；kyuubi.engine.share.level，默认值为 USER。

如果通过 kyuubi.engine.pool.size 启用了引擎池模式，则子域由 kyuubi.engine.pool.name 和一个小于该大小的数字组成，例如 engine-pool-0。

--engine-share-level 支持以下枚举值。

CONNECTION

必须通过 --engine-subdomain 指定引擎 Ref Id（UUID）。

USER:

默认值。

GROUP:

--user 参数为该用户所属的组名。

SERVER:

--user 参数为启动 kyuubi server 的用户。

列出引擎

列出某个用户的所有引擎节点。

bin/kyuubi-ctl list engine --user AAA

管理共享级别为 SERVER，启动 kyuubi server 的用户为 A，引擎为 TRINO，子域为 adhoc。

bin/kyuubi-ctl list engine --user A --engine-type TRINO --engine-subdomain adhoc --engine-share-level SERVER

获取引擎

获取属于某个用户的 Kyuubi 引擎信息。

bin/kyuubi-ctl get engine --user AAA --host XXX --port YYY

Delete engine

为用户删除指定的引擎节点。

引擎节点被删除后，Kyuubi 引擎将停止接受新的会话，并在所有当前已打开的会话关闭后退出进程。

bin/kyuubi-ctl delete engine --user AAA --host XXX --port YYY

用法