In the Kafka world nothing is easy, but esque (pronounced esk) is an attempt at it.
Some stuff is hard, and that is okay, listing your kafka topics shouldn't be.
While adopting kafka at real.digital we noticed the immense entry barrier it poses to newcomers. We can't recount how often we wrote Slack messages asking for the script to check the status of topics or consumergroups. This is partly (but not only) due to a fragmented and unclear definition of tooling and APIs for kafka.
esque tries to become a human-friendly point of first contact for your kafka cluster by exposing a kubectl-like interface to it.
- List Resources (Topics, Consumergroups, Brokers)
- Get detailed Overviews of Resources (Topics, Consumergroups, Brokers)
- Create/Delete Topics
- Context Switch (Easily Switch between pre-defined Clusters)
- Kafka Ping (Test roundtrip time to your kafka cluster)
- and many more planned...
esque is available at pypi.org and can be installed with pip install esque. esque requires Python 3.6+ to run.
Autocompletion is automatically installed via a post-install hook in the setup.py. If it doesn't work for some reason you can still install it yourself:
echo 'eval "$(_ESQUE_COMPLETE=source esque)"' >> ~/.esque/autocompletion.sh
echo "source ~/.esque/autocompletion.sh" >> ~/.bashrc
echo 'eval "$(_ESQUE_COMPLETE=source_zsh esque)"' >> ~/.esque/autocompletion.zsh
echo "source ~/.esque/autocompletion.zsh" >> ~/.zshrc
When starting esque for the first time the following message will appear:
No config provided in ~/.esque
Should a sample file be created in ~/.esque [y/N]:
When answering with y esque will copy over the sample config to ~/.esque/esque.cfg.
Afterwards you can modify that file to fit your cluster definitions.
Alternatively might just provide a config file following the sample config's file in that path.
$ esque
Usage: esque [OPTIONS] COMMAND [ARGS]...
(Kafka-)esque.
Options:
--help Show this message and exit.
Commands:
apply Apply a configuration
create Create a new instance of a resource.
ctx Switch clusters.
delete Delete a resource.
describe Get detailed informations about a resource.
get Get a quick overview of different resources.
ping Tests the connection to the kafka cluster.
The config for the apply command has to be a yaml file and is given with the option -f or --file.
In the current version only topic configurations can be changed and specified.
It has to use the schema, which is used for the following example:
topics:
- name: topic_one
replication_factor: 3
num_partitions: 50
config:
cleanup.policy: compact
- name: topic_two
replication_factor: 3
num_partitions: 50
config:
cleanup.policy: compact
To setup your development environment, make sure you have at least Python 3.6 & Pipenv installed, then run
pipenv install --dev
pipenv shell
export PYTHONPATH=$(pwd)
To start up a local test setup (Kafka and Zookeeper), you can run
docker-compose up
While this docker-compose stack is up, you can run the tests from the CLI via pytest tests/ --integration --local
Alternatively, you can also run the entire test suite, without needing to setup the development environment, in docker compose via docker-compose -f docker-compose.yml -f docker-compose.test.yml
To install pre commit hooks run:
pip install pre-commit
pre-commit install
pre-commit install-hooks