diff --git a/README.md b/README.md index fc50265..672422e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@

kaskade

-GitHub + +GitHub +DockerHub MIT License Version Python Versions Platform -Libraries.io dependency status for latest release - +Libraries.io dependency status for latest release ## Kaskade @@ -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 @@ -61,8 +62,6 @@ pipx install kaskade pipx upgrade kaskade ``` -docker image available - ## Running kaskade #### Help: @@ -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: @@ -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: @@ -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: @@ -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