This release is a pre-release and may not be stable for production use.
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).
sudo pip install strimzi-kafka-cli
IMPORTANT
We recommend to use sudo while installing Strimzi Kafka CLI because the binary will directly be located in /usr/local/bin which is accessible from all users of the OS. If you don't want this, and want to install the CLI without sudo you will get this kind of warning:
WARNING: The script kfk is installed in '[USER_HOME]/[PYTHON_PATH]/bin' which is not on PATH.
Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
So in this case you need to put the shown location of kfk on PATH.
Project requires: Python >=3.5
Examples
You can access the examples from here.
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.
1 maintainer
Release files for strimzi-kafka-cli 0.1.0a30
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| strimzi-kafka-cli-0.1.0a30.tar.gz | 14.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| strimzi_kafka_cli-0.1.0a30-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 35.7 kB
Release files / strimzi-kafka-cli-0.1.0a30.tar.gz
| Download URL | strimzi-kafka-cli-0.1.0a30.tar.gz |
|---|---|
| Size | 14.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e4792543bba614005ce36042adc591cf33ddf46d24afc1c952fd6ed52806c565
|
|
BLAKE2b-256 checksum How to use checksums |
41dc30fa29ac84e52e3e9671328c9ace86ba888d5a1c7eeef5c2d077ee9d70fc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.5
|
Release files / strimzi_kafka_cli-0.1.0a30-py3-none-any.whl
| Download URL | strimzi_kafka_cli-0.1.0a30-py3-none-any.whl |
|---|---|
| Size | 21.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
04e8bb31f34640cec431043ff0fb94fdca3efa53ac9e381eed2c04843bfd6f9b
|
|
BLAKE2b-256 checksum How to use checksums |
dcfd08b6fa1537ee51eb9fe0fc17bfd7fa12770e484c35fc829e83c63fea2f2a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.5
|
