4.0

Connect CLI


View on GitHub Download

This is a command line interface (CLI) around the Kafka Connect REST Interface to manage connectors. It is used in a git like fashion where the first program argument indicates the command.

The CLI is meant to behave as a good Unix citizen: input from stdin; output to stdout; out of band info to stderr and non-zero exit status on error. Commands dealing with configuration expect or produce data in .properties style: key=value lines and comments start with a #.

JSON config files can be used with the -f | –format flag.

You can override the default endpoint by setting an environment variable KAFKA_CONNECT_REST or the -e | –endpoint flag i.e.

export KAFKA_CONNECT_REST="http://myserver:myport"

connect-cli 1.0.8
Usage: connect-cli [ps|get|rm|create|run|diff|status|plugins|describe|validate|restart|pause|resume] [options] [<connector-name>]

--help
        prints this usage text
-e <value> | --endpoint <value>
        Kafka Connect REST URL, default is http://localhost:8083/
-f <value> | --format <value>
        The format of the config, default is PROPERTIES. Valid options are 'properties' and 'json'.

Command: ps
list active connectors names.

Command: get
get the configuration of the specified connector.

Command: rm
remove the specified connector.

Command: create
create the specified connector with the config from stdin; the connector cannot already exist.

Command: run
create or update the specified connector with the config from stdin.

Command: diff
diff the specified connector with the config from stdin.

Command: status
get connector and task(s) state(s).

Command: plugins
list the available connector class plugins on the classpath.

Command: describe
list the configurations for a connector class plugin on the classpath.

Command: pause
pause the specified connector.

Command: restart
restart the specified connector.

Command: resume
resume the specified connector.

Command: validate
validate the connector config from stdin against a connector class plugin on the classpath.