Heroku Kafka CLI Plugin
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
commands
lib Revamp config var lookup to make it more robust (#174) Aug 4, 2017
script plan partition assignment Aug 25, 2015
test added max-length flag to topics tail Jul 18, 2018
.eslintrc Update eslint config to match standard Aug 30, 2016
.gitignore
.travis.yml Bump node version to what the CLI is currently on Jul 11, 2017
CODEOWNERS add CODEOWNERS May 15, 2018
LICENSE Add a license Apr 26, 2016
README.md
package.json
yarn.lock use non-native snappyjs (#185) Apr 4, 2018

README.md

Heroku Kafka Plugin

Build Status Coverage Status

A plugin to manage Heroku Kafka.

heroku kafka:consumer-groups [CLUSTER]                         # lists available Kafka consumer groups
heroku kafka:consumer-groups:create CONSUMER_GROUP [CLUSTER]   # creates a consumer group in Kafka
heroku kafka:consumer-groups:destroy CONSUMER_GROUP [CLUSTER]  # destroys a consumer group in Kafka
heroku kafka:fail [CLUSTER]                                    # triggers failure on one node in the cluster
heroku kafka:info [CLUSTER]                                    # display cluster information
heroku kafka:topics [CLUSTER]                                  # lists available Kafka topics
heroku kafka:topics:compaction TOPIC VALUE [CLUSTER]           # configures topic compaction in Kafka
heroku kafka:topics:create TOPIC [CLUSTER]                     # creates a topic in Kafka
heroku kafka:topics:destroy TOPIC [CLUSTER]                    # deletes a topic in Kafka
heroku kafka:topics:info TOPIC [CLUSTER]                       # shows information about a topic in Kafka
heroku kafka:topics:replication-factor TOPIC VALUE [CLUSTER]   # configures topic replication factor in Kafka
heroku kafka:topics:retention-time TOPIC VALUE [CLUSTER]       # configures topic retention time (e.g. 10d, 36h)
heroku kafka:topics:tail TOPIC [CLUSTER]                       # tails a topic in Kafka
heroku kafka:topics:write TOPIC MESSAGE [CLUSTER]              # writes a message to a Kafka topic
heroku kafka:upgrade [CLUSTER]                                 # upgrades kafka broker version
heroku kafka:wait [CLUSTER]                                    # waits until Kafka is ready to use

Install

$ heroku plugins:install heroku-kafka

Development

For normal development, the initial setup is:

# ensure node 8.x is installed
$ yarn
$ heroku plugins:link

Publishing

To publish new versions, see the data plugin documentation.