Skip to content

Commit

Permalink
minor: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sauljabin committed Jul 2, 2024
1 parent 6db63a5 commit 21f6758
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
<p align="center">
<a href="https://github.com/sauljabin/kaskade"><img alt="kaskade" width="400" src="https://raw.githubusercontent.com/sauljabin/kaskade/main/screenshots/banner.png"></a>
</p>
<a href="https://github.com/sauljabin/kaskade"><img alt="GitHub" height="20" src="https://img.shields.io/badge/-github-blueviolet?logo=github&logoColor=white"></a>

<a href="https://github.com/sauljabin/kaskade"><img alt="GitHub" src="https://img.shields.io/badge/-github-blueviolet?logo=github&logoColor=white"></a>
<a href="https://hub.docker.com/r/sauljabin/kaskade"><img alt="DockerHub" src="https://img.shields.io/badge/-docker-blue?logo=docker&logoColor=white"></a>
<a href="https://github.com/sauljabin/kaskade/blob/main/LICENSE"><img alt="MIT License" src="https://img.shields.io/github/license/sauljabin/kaskade"></a>
<a href="https://pypi.org/project/kaskade"><img alt="Version" src="https://img.shields.io/pypi/v/kaskade?label=latest"></a>
<a href="https://pypi.org/project/kaskade"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/kaskade?label=python"></a>
<a href="https://pypi.org/project/kaskade"><img alt="Platform" src="https://img.shields.io/badge/os-linux%20%7C%20macos-blue"></a>
<a href="https://libraries.io/pypi/kaskade"><img alt="Libraries.io dependency status for latest release" src="https://img.shields.io/librariesio/release/pypi/kaskade">
</a>
<a href="https://libraries.io/pypi/kaskade"><img alt="Libraries.io dependency status for latest release" src="https://img.shields.io/librariesio/release/pypi/kaskade"></a>

## Kaskade

Expand All @@ -18,7 +19,7 @@ It includes features like:
- List topics, partitions, groups and group members
- Topic information like lag, replicas and records count
- Create, edit and delete topics
- Filter topics
- Filter topics by name
- Consumer:
- Json, string, integer, long, float, boolean and double deserialization
- Filter by key, value, header and/or partition
Expand Down Expand Up @@ -61,8 +62,6 @@ pipx install kaskade
pipx upgrade kaskade
```

<a href="https://hub.docker.com/r/sauljabin/kaskade"><img alt="docker image available" height="20" src="https://img.shields.io/badge/-docker image available-blue?logo=docker&logoColor=white"></a>

## Running kaskade

#### Help:
Expand All @@ -85,6 +84,13 @@ kaskade admin -b localhost:9092
kaskade consumer -b localhost:9092 -t my-topic
```

#### Running with docker:

```shell
docker run --rm -it --network my-networtk sauljabin/kaskade:latest admin -b kafka1:9092
docker run --rm -it --network my-networtk sauljabin/kaskade:latest consumer -b kafka1:9092 -t my-topic
```

## Configuration examples

#### Multiple bootstrap servers:
Expand All @@ -111,9 +117,11 @@ kaskade consumer -b localhost:9092 -t my-topic -x auto.offset.reset=earliest
kaskade consumer -b localhost:9092 -s url=http://localhost:8081 -t my-topic -k avro -v avro
```

> More Schema Registry configurations at: [SchemaRegistryClient](https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#schemaregistry-client).
> More Schema Registry configurations
> at: [SchemaRegistryClient](https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#schemaregistry-client).
> librdkafka clients do not currently support AVRO Unions in (de)serialization, more at: [Limitations for librdkafka clients](https://docs.confluent.io/platform/current/schema-registry/fundamentals/serdes-develop/serdes-avro.html#limitations-for-librdkafka-clients).
> librdkafka clients do not currently support AVRO Unions in (de)serialization, more
> at: [Limitations for librdkafka clients](https://docs.confluent.io/platform/current/schema-registry/fundamentals/serdes-develop/serdes-avro.html#limitations-for-librdkafka-clients).
#### SSL encryption example:

Expand All @@ -123,7 +131,8 @@ kaskade admin -b ${BOOTSTRAP_SERVERS} -x security.protocol=SSL

> For more information about SSL encryption and SSL authentication go
> to the `librdkafka` official
> page: [Configure librdkafka client](https://github.com/edenhill/librdkafka/wiki/Using-SSL-with-librdkafka#configure-librdkafka-client).
>
page: [Configure librdkafka client](https://github.com/edenhill/librdkafka/wiki/Using-SSL-with-librdkafka#configure-librdkafka-client).

#### Confluent cloud admin:

Expand All @@ -150,7 +159,8 @@ kaskade consumer -b ${BOOTSTRAP_SERVERS} \
-v avro
```

> More about confluent cloud configuration at: [Kafka Client Quick Start for Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/config-client.html).
> More about confluent cloud configuration
> at: [Kafka Client Quick Start for Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/config-client.html).
## Development

Expand Down

0 comments on commit 21f6758

Please sign in to comment.