kaskade 0.2.7

kaskade is a terminal user interface for kafka

kaskade is a tui (terminal user interface) for kafka. It is built on textual tui framework and rich lib.

For a local kafka environment go to https://github.com/sauljabin/kafka-docker.

NOTE: This project is currently a work in progress, but usable by early adopters. textual is also a work in progress project.

Table of Contents

• Installation and Usage
• Running with Docker
• Configuration
• Screenshots
• Alternatives
• To Do
• Development
  • Scripts
  • Docker
  • Bumping Version

Installation and Usage

Install with pip:

pip install kaskade

pip will install kaskade and kskd aliases.

Upgrade with pip:

pip install --upgrade kaskade

Help:

kaskade --help

Version:

kaskade --version

Run without config file (it'll take any of kaskade.yml, kaskade.yaml, config.yml or config.yaml):

kaskade

Run with config file:

kaskade my-file.yml

Running with Docker

Using docker (remember to set a network and volume):

docker run --rm -it --network kafka-sandbox_network \
--volume $(pwd):/kaskade \
sauljabin/kaskade:latest

Aliases:

alias kaskade='docker run --rm -it --network kafka-sandbox_network \
--volume $(pwd):/kaskade \
sauljabin/kaskade:latest'

alias kskd=kaskade

These aliases will mount the current directory as a volume.

Configuration

A default yaml configuration file name can be either kaskade.yml , kaskade.yaml, config.yml or config.yaml. It supports all the configuration on kafka consumer configuration page.

Simple connection example:

kafka:
  bootstrap.servers: localhost:9093

SSL encryption example:

kafka:
  bootstrap.servers: kafka:9092
  security.protocol: SSL
  ssl.truststore.location: {{path}}/truststore.jks
  ssl.truststore.password: {{password}}

SSL auth example:

kafka:
  bootstrap.servers: kafka:9092
  security.protocol: SSL
  ssl.truststore.location: {{path}}/truststore.jks
  ssl.truststore.password: {{password}}
  ssl.keystore.location: {{path}}/keystore.jks
  ssl.keystore.password: {{password}}
  ssl.key.password: {{password}}

Support for env variables:

kafka:
  bootstrap.servers: ${BOOTSTRAP_SERVERS}

Screenshots

Alternatives

• cli kcat
• cli zoe
• cli kaf
• wui akhq
• tui kcli

To Do

• Consumed messages table
• Consumer group lag
• Interactive search and filters
• Topic size and count
• Schema registry support
• Increment test coverage

Development

Installing poetry:

pip install poetry

Installing development dependencies:

poetry install

Installing pre-commit hooks:

poetry run pre-commit install

Running kaskade:

poetry run kaskade

Scripts

Running unit tests:

poetry run python -m scripts.tests

Running multi-version tests (versions):

poetry run python -m scripts.multi-version-tests

Applying code styles:

poetry run python -m scripts.styles

Running code analysis:

poetry run python -m scripts.analyze

Running code coverage:

poetry run python -m scripts.tests-coverage

Running pre-commit hooks:

poetry run python -m scripts.pre-commit

Generate readme banner:

poetry run python -m scripts.banner

Docker

Build docker:

poetry run python -m scripts.docker-build

Image tag sauljabin/kaskade:latest.

Run with docker (create a config.yml file):

docker run --rm -it --network kafka-sandbox_network \
--volume $(pwd):/kaskade \
sauljabin/kaskade:latest

Bumping Version

Help:

poetry run python -m scripts.release --help

More info at https://python-poetry.org/docs/cli/#version and https://semver.org/.

Upgrade (major.minor.patch):

poetry run python -m scripts.release patch