命令行工具

总览

除了 InLong Dashboard，你可以通过命令行工具来查看管理 InLong 的相关资源。

命令行工具可以在 InLong 的 bin 目录运行。

用法：

$ bin/inlongctl [options] [command] [command options]

命令：

• list
• describe
• create
• update
• delete
• log

同时也可以使用 --help 或者 -h 获取上述命令的帮助，例如：

$ bin/inlongctl list -h

配置

前往 inlong-manager 目录，修改 conf/application.properties 文件的以下配置即可。

server.host=127.0.0.1
server.port=8080
default.admin.user=admin
default.admin.password=inlong

List

list 用于展示相关资源的核心信息，并以表格的方式展示。

命令：

• group
• stream
• source
• sink
• cluster
• cluster-tag
• cluster-node
• user

group

$ bin/inlongctl list group

选项：

group status 说明

stream

$ bin/inlongctl list stream

选项：

* 表示为必需参数

source

$ bin/inlongctl list source

选项：

stream source type 说明

sink

$ bin/inlongctl list sink

选项：

cluster-tag

$ bin/inlongctl list cluster-tag

选项：

cluster

$ bin/inlongctl list cluster

选项：

cluster type 说明

cluster-node

$ bin/inlongctl list cluster-node

选项：

user

$ bin/inlongctl list user

选项：

user type 说明

Describe

describe 用于展示相关资源的详细信息，直接以 Json 格式展示。

命令：

• group
• stream
• source
• sink
• cluster
• cluster-tag
• cluster-node
• user

group

$ bin/inlongctl describe group

选项：

group status 说明

stream

$ bin/inlongctl describe stream

选项：

source

$ bin/inlongctl describe source

选项：

stream source type 说明

sink

$ bin/inlongctl describe sink

选项：

cluster-tag

$ bin/inlongctl describe cluster-tag

选项：

cluster

$ bin/inlongctl describe cluster

选项：

cluster-node

$ bin/inlongctl describe cluster-node

选项：

user

$ bin/inlongctl describe user

选项：

Create

create 用于创建相关资源，目前通过使用 json 文件的方式创建

命令：

• cluster
• cluster-tag
• cluster-node
• user

cluster

$ bin/inlongctl create cluster

选项：

json 示例：

{
  "name": "test_cluster",
  "url": "127.0.0.1:8080",
  "clusterTags": "test_cluster_tag",
  "extTag": null,
  "description": null,
  "inCharges": "admin",
  "type": "PULSAR",
  "adminUrl": "http://127.0.0.1:8080",
  "tenant": "public"
}

cluster-tag

$ bin/inlongctl create cluster-tag

选项：

json 示例：

{
  "clusterTag": "test_cluster_tag",
  "inCharges": "ctl",
  "extParams": null,
  "description": null
}

cluster-node

$ bin/inlongctl create cluster-node

选项：

json 示例：

{
  "parentId": 1,
  "type": "AGENT",
  "ip": "127.0.0.1",
  "port": 8008,
  "extParams": null,
  "description": "null"
}

parentId 为该节点对应 cluster 的 id，可通过 list cluster 或 describe cluster 查看

user

$ bin/inlongctl create user

选项：

Update

update 用于修改相关资源，目前通过使用 json 文件的方式修改

命令：

• cluster
• cluster-tag
• cluster-node
• user

update 所需的 json 文件可以在 describe 得到的 json 上进行需要的修改即可。

cluster

$ bin/inlongctl update cluster

选项：

cluster-tag

$ bin/inlongctl update cluster-tag

选项：

cluster-node

$ bin/inlongctl update cluster-node

选项：

user

$ bin/inlongctl update user

选项：

Delete

delete 用于删除相关资源。

命令：

• group
• stream
• source
• sink
• cluster
• cluster-tag
• cluster-node
• user

group

$ bin/inlongctl delete group

选项：

group status 说明

stream

$ bin/inlongctl delete stream

选项：

source

$ bin/inlongctl delete source

选项：

stream source type 说明

sink

$ bin/inlongctl delete sink

选项：

cluster-tag

$ bin/inlongctl delete cluster-tag

选项：

cluster

$ bin/inlongctl delete cluster

选项：

cluster-node

$ bin/inlongctl delete cluster-node

选项：

user

$ bin/inlongctl delete user

选项：

Log

创建任务流程之后，可以使用 log 命令查看任务各阶段的执行日志

命令：

• group

group

$ bin/inlongctl log group

选项：