Command-line Tools

Overview

In addition to InLong Dashboard, you can view and create data resources through command-line tools.

inlongctl can be run from InLong’s bin directory.

usage:

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

command:

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

You can also use --help or -h to get help for the above commands, for example:

$ bin/inlongctl list -h

Configuration

Go to the inlong-manager directory , modify the following configurations of the conf/application.properties file.

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

List

list is used to display the core information of resources and display them in a table.

command:

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

group

$ bin/inlongctl list group

options:

group status

stream

$ bin/inlongctl list stream

options:

* means required parameter.

source

$ bin/inlongctl list source

options:

stream source type

sink

$ bin/inlongctl list sink

options:

cluster-tag

$ bin/inlongctl list cluster-tag

options:

cluster

$ bin/inlongctl list cluster

options:

cluster type

cluster-node

$ bin/inlongctl list cluster-node

options:

user

$ bin/inlongctl list user

options:

user type

Describe

describe is used to display detailed information and output in json format.

command:

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

group

$ bin/inlongctl describe group

options:

group status

stream

$ bin/inlongctl describe stream

options:

source

$ bin/inlongctl describe source

options:

stream source type

sink

$ bin/inlongctl describe sink

options:

cluster-tag

$ bin/inlongctl describe cluster-tag

options:

cluster

$ bin/inlongctl describe cluster

options:

cluster-node

$ bin/inlongctl describe cluster-node

options:

user

$ bin/inlongctl describe user

options:

Create

create is used to create resources, currently created by using a json file.

command:

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

cluster

$ bin/inlongctl create cluster

options:

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

options:

json:

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

cluster-node

$ bin/inlongctl create cluster-node

options:

json:

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

parentId is the corresponding cluster id of this node, and the cluster id can be obtained through list cluster or describe cluster

user

$ bin/inlongctl create user

options:

Update

update is used to update resources, currently update by using a json file.

command:

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

The json file required by update can be modified on the json obtained by describe.

cluster

$ bin/inlongctl update cluster

options:

cluster-tag

$ bin/inlongctl update cluster-tag

options:

cluster-node

$ bin/inlongctl update cluster-node

options:

user

$ bin/inlongctl update user

options:

Delete

delete is used to delete resources.

command:

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

group

$ bin/inlongctl delete group

options:

group status

stream

$ bin/inlongctl delete stream

options:

source

$ bin/inlongctl delete source

options:

stream source type

sink

$ bin/inlongctl delete sink

options:

cluster-tag

$ bin/inlongctl delete cluster-tag

options:

cluster

$ bin/inlongctl delete cluster

options:

cluster-node

$ bin/inlongctl delete cluster-node

options:

user

$ bin/inlongctl delete user

options:

Log

After creating the task process, you can use the log command to view the execution log of each stage of the task.

command:

• group

group

$ bin/inlongctl log group

options: