Skip to main content

Command Line Interface for Strimzi Kafka Operator

Project description

Build Deploy PyPI version

strimzi cli

Strimzi Kafka CLI

Strimzi Kafka CLI is a CLI that helps traditional Apache Kafka users -mostly administrators- to easily adapt Strimzi, a Kubernetes operator for Apache Kafka.

Intention here is to ramp up Strimzi usage by creating a similar CLI experience with traditional Apache Kafka binaries. For example:

Native Command Strimzi CLI Command
$KAFKA_HOME/bin/kafka-topics.sh kfk topics
$KAFKA_HOME/bin/kafka-configs.sh kfk configs
$KAFKA_HOME/bin/kafka-console-consumer.sh kfk console-consumer
... ...

kfk command stands for the usual kafka-* prefix of the Apache Kafka runnable files which are located in bin directory. There are options provided like topics, console-consumer, etc. which also mostly stand for the rest of the runnable file names like kafka-topic.sh.

However, because of the nature of Strimzi and its capabilities, there are also unusual options like clusters which is used for cluster configuration or users which is used for user management and configuration.

Following is the high-level output of the Strimzi Kafka CLI:

Usage: kfk [OPTIONS] COMMAND [ARGS]...

  Strimzi Kafka CLI

Options:
  --help  Show this message and exit.

Commands:
  acls              This tool helps to manage ACLs on Kafka.
  clusters          The kafka cluster(s) to be created, altered or...
  configs           Add/Remove entity config for a topic, client, user or...
  console-consumer  The console consumer is a tool that reads data from...
  console-producer  The console producer is a tool that reads data from...
  topics            The kafka topic(s) to be created, altered or described.
  users             The kafka user(s) to be created, altered or described.
  version           Prints the version of Strimzi Kafka CLI

Installation

Strimzi Kafka CLI can be installed via pip (python package installer).

pip install strimzi-kafka-cli

Project requires: Python >=3.5

Dependencies

Python Dependencies

Please see requirements.txt file.

External Dependencies

  • kubectl: kfk will automatically download kubectl binary which is configurable to use which kubectl version to use. (Pls see issue-19)
  • Strimzi binaries: kfk will download it automatically. The yaml templates are used for create actions. This is configurable to use which binaries path to use. (Pls see issue-19)

More info will be added soon.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for strimzi-kafka-cli, version 0.1.0a28
Filename, size File type Python version Upload date Hashes
Filename, size strimzi_kafka_cli-0.1.0a28-py3-none-any.whl (20.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size strimzi-kafka-cli-0.1.0a28.tar.gz (12.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page