Welcome to connectctl’s documentation!

connectctl installation

The contains details of how to install and uninstall connectctl

Requirements

connectctl runs on Linux, Windows and MacOS.

Download the binary

The connectctl binary can be downloaded from the releases section. Its advised that you make the binary available in your PATH.

Future work

We’ll be supplying an install script and support for various package managers in the future.

FAQ

Any questions realted to connecttl:

connectctl

connectctl: manage Kafka Connect

connectctl

connectctl: work with Kafka Connect easily

Synopsis

connectctl is a cli that makes working with kafka connect easier. It can be used to manage connectors and plugins and to also also actively manage/reconcile the state of a cluster.

The operations you can perform are split into 2 subcommands: connectors Manage Kafka Connect connectors plugins Manage Kafka connect connector plugins

Example usage:

$ connectctl connectors add  \
	-c http://connect:8083 
$ connectctl connectors list -c http://connect:8083

Options

  -h, --help                    Help for connectctl
  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl connectors

perform a connector operation against a Kafka Connect cluster

Synopsis

Perform operations against a Kafka Connect cluster that relate to connectors. Operations are always against a specific cluster and URL must be supplied.

connectctl connectors <command...> [flags]

Options

None, all options are at the subcommand level

Options inherited from parent commands

  -h, --help                    Help for connectctl
  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl connectors add

Add a connector

Synopsis

Creates a new connector based on a definition ina cluster. It can create one or more connectors in a single execution.

connectctl connectors add [flags]

Options

  -h, --help   help for add
  -c, --clusterURL  the url of the kafka connect cluster to create the connectors in
  -f, --files       the json file containing the connector definition. Multiple files can be specified
                    either by comma separating file1.json,file2.json or by repeating the flag.
  -d, --directory   a director that contains json files with the connector definitions to add

NOTE: the -d and -f options are mutually exclusive.

Options inherited from parent commands

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl connectors list

List the connectors

Synopsis

Lists all the connectors in a given Kafka Connect cluster. The output includes the connecor status and the format can be specified.

connectctl connectors list [flags]

Options

  -h, --help        help for add
  -c, --clusterURL  the url of the kafka connect cluster to remove the connectors from
  -o, --output      specify the format of the list of connectors.  Valid options
                    are json and table. The default is json.

Options inherited from parent commands

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl connectors manage

Actively manage connectors in a cluster

Synopsis

This command will actively manage connectors in a cluster by creating, updating, removing and restarting connectors. The command can be run once or it can run continously where it will sync the desired state and actually state on a periodic basis.

connectctl connectors manage [flags]

Options

  -h, --help   help     for add
  -c, --clusterURL      the url of the kafka connect cluster to avtively manage
  -f, --files           the json file(s) containing the connector definition. Multiple files can be specified
                        either by comma separating file1.json,file2.json or by repeating the flag.
  -d, --directory       a director that contains json files with the connector definitions to add
  -s, --sync-period     how often to check the current state of the connectors in the lcuster specified
                        by -c and the desired stats of the connectors as specified by -f or -d.
                        The default is 5 minutes.
      --allow-purge     if specified then any connectors that are found in the cluster that aren't
                        in the desired state (as spcified by -f or -d) will be deleted from the cluster.
                        The default is false.
      --auto-restart    if specified then connector tasks will be restarted if they are in a FAILED state
                        The default is false.
      --once            if specified the command will run once and then exit. The default is false.

NOTE: the -d and -f options are mutually exclusive. If you don’t specify –once then the command will run continuosly and will try and synchronise the state of the cluster according the duration specific by the -s option.

Options inherited from parent commands

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl connectors pause

Pause connectors

Synopsis

Pauses connectors in a specified Kafka Connect cluster. It can pause one or more connectors in a single execution.

connectctl connectors pause [flags]

Options

  -h, --help        help for add
  -c, --clusterURL  the url of the kafka connect cluster to pause connectors in
  -n, --connectors  the names of the connectors to pause. Multiple connector names 
                    can be specified either by comma separating conn1,conn2
                    or by repeating the flag --n conn1 --n conn2. If no name is
                    supplied then ALL connectors will be paused.

Options inherited from parent commands

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl connectors remove

Remove a connector

Synopsis

Removes a named connector from a cluster. It can remove one or more connectors in a single execution.

connectctl connectors remove [flags]

Options

  -h, --help        help for add
  -c, --clusterURL  the url of the kafka connect cluster to remove the connectors from
  -n, --connectors  the names of the connectors to remove. Multiple connector names 
                    can be specified either by comma separating conn1,conn2
                    or by repeating the flag --n conn1 --n conn2.

Options inherited from parent commands

connectctl connectors remove

Remove a connector

Synopsis

Removes a named connector from a cluster. It can remove one or more connectors in a single execution.

connectctl connectors remove [flags]

Options

  -h, --help        help for add
  -c, --clusterURL  the url of the kafka connect cluster to remove the connectors from
  -n, --connectors  the names of the connectors to remove. Multiple connector names 
                    can be specified either by comma separating conn1,conn2
                    or by repeating the flag --n conn1 --n conn2.

Options inherited from parent commands

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl connectors restart

Restart connectors

Synopsis

Restart connectors in a specified Kafka Connect cluster. It can restart one or more connectors in a single execution.

connectctl connectors restart [flags]

Options

  -h, --help        help for add
  -c, --clusterURL  the url of the kafka connect cluster to restart connectors in
  -n, --connectors  the names of the connectors to restart. Multiple connector names 
                    can be specified either by comma separating conn1,conn2
                    or by repeating the flag --n conn1 --n conn2. If no name is
                    supplied then ALL connectors will be restarted.

Options inherited from parent commands

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl connectors resume

Resume connectors

Synopsis

Resume connectors in a specified Kafka Connect cluster. It can resume one or more connectors in a single execution.

connectctl connectors resume [flags]

Options

  -h, --help        help for add
  -c, --clusterURL  the url of the kafka connect cluster to resume connectors in
  -n, --connectors  the names of the connectors to resume. Multiple connector names 
                    can be specified either by comma separating conn1,conn2
                    or by repeating the flag --n conn1 --n conn2. If no name is
                    supplied then ALL connectors will be resumed.

Options inherited from parent commands

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl connectors status

Status of connectors

Synopsis

Display status of selected connectors. If some tasks or connectors are failing, command will exit with code 1.

connectctl connectors status [flags]

Options

  -h, --help        help for add
  -c, --clusterURL  the url of the kafka connect cluster
  -n, --connectors  the names of the connectors. Multiple connector names 
                    can be specified either by comma separating conn1,conn2
                    or by repeating the flag --n conn1 --n conn2. If no name is
                    supplied status of ALL connectors will be displayed.
  -o, --output      specify the output format (valid options: json, table) (default "json")
  -q, --quiet       disable output logging

Options inherited from parent commands

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl plugins

Manage connector plugins

Synopsis

Perform operations against a Kafka Connect cluster that relate to connector plugins. Operations are always against a specific cluster and URL must be supplied.

connectctl plugins <command...> [flags]

Options

None, all options are at the subcommand level

Options inherited from parent commands

  -h, --help                    Help for connectctl
  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl plugins list

List connector plugins

Synopsis

Lists all the connector plugins installed on a given Kafka Connect cluster node. The output can be formatted as JSON or a table.

connectctl plugins list [flags]

Options

  -h, --help        help for add
  -c, --clusterURL  the url of the kafka connect cluster to list the plugins from
  -o, --output      specify the format of the list of plugins.  Valid options
                    are json and table. The default is json.

Options inherited from parent commands

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl plugins validate

Validates connector config

Synopsis

Validate the provided configuration values against the configuration definition. This API performs per config validation, outputs suggested values and error messages during validation. It exits with code 1 if config is invalid.

connectctl plugins validate [flags]

Options

  -c, --cluster string   the URL of the connect cluster (required)
  -h, --help             help for validate
  -i, --input string     Input data in json format (required)
  -o, --output string    specify the output format (valid options: json, table) (default "json")
  -q, --quiet            disable output logging

Options inherited from parent commands

  -l, --loglevel loglevel       Specify the loglevel for the program (default info)
      --logfile                 Specify a file to output logs to

SEE ALSO

connectctl version

Print the version of connectctl

Synopsis

Prints version information of connectctl

connectctl version

Options

  -h, --help        help for version
  -c, --clusterURL  the url of the kafka connect cluster

SEE ALSO

  • connectctl - connectctl: work with Kafka Connect easily

Indices and tables