Quick Start

Get started with kPow for Apache Kafka in under two minutes

This page provides Quick Start instructions for Docker and JAR installations.

Use our Helm and CloudFormation guides to get up and running in minutes.

Docker Quick Start

kPow Docker images are hosted at Docker Hub.

To connect the latest kPow Docker image to a Kafka Cluster:

  • Create a config.env file containing your connection, license, and feature variables.

## The Kafka Bootstrap URL for your cluster (Required).
BOOTSTRAP=kafka-1:9092,kafka-2:9092,kafka-3:9092
## Your license details (Required).
## These parameters can be cut/paste from your license email
LICENSE_ID=1c99v4-f690-4a4f-b144-73de2369444a
LICENSE_CODE=TRIAL_30D
LICENSEE=My Corp
LICENSE_EXPIRY=2020-09-05
LICENSE_SIGNATURE=15CFFF969111DB6DCA142B6F1E0065F94A614251B80128D52C2CD45993A021AE10E90F57B90FF76CC1B992C16E54BCF1CBE7E5EE3124B3E585BE133774836A6EBB51B55E67EF60F4A435EBEC9F07A26CEABDCF6E3CF4137A33201E7662AF1F7986E57341E0EAEB884BBF320C348D62679F521259DAD1E03F6F79DB53D83CD41B
## Optional from here:
## Name your Operatr installation (this appears in the UI)
ENVIRONMENT_NAME=Trade Book (Staging)
## Operatr Feature Flags (See: RBAC for per user controls):
## Allow users to create new topics
ALLOW_TOPIC_CREATE=true
## Allow users to delete topics
ALLOW_TOPIC_DELETE=true
## Allow users to edit topic configuration
ALLOW_TOPIC_EDIT=true
## Allow users to view topic data
ALLOW_TOPIC_INSPECT=true
## Allow users to produce messages to topics
ALLOW_TOPIC_PRODUCE=true
## ... etc (see guide for more configuration flags).
  • Start the latest kPow container with your config.env file.

docker run -p 3000:3000 -m2G --env-file ./config.env operatr/kpow:latest
  • kPow is now running on http://localhost:3000

JAR Quick Start

To connect the latest kPow JAR to a Kafka cluster:

Note: Quoting may be required for some variables

Some variables may require quotes, and each line ends with a \ character.

BOOTSTRAP="kafka-1:9092,kafka-2:9092,kafka-3:9092" \
LICENSE_ID=1c99v4-f690-4a4f-b144-73de2369444a \
LICENSE_CODE=TRIAL_30D \
LICENSEE="My Corp" \
LICENSE_EXPIRY=2020-09-05 \
LICENSE_SIGNATURE=15CFFF969111DB6DCA142B6F1E0065F94A614251B80128D52C2CD45993A021AE10E90F57B90FF76CC1B992C16E54BCF1CBE7E5EE3124B3E585BE133774836A6EBB51B55E67EF60F4A435EBEC9F07A26CEABDCF6E3CF4137A33201E7662AF1F7986E57341E0EAEB884BBF320C348D62679F521259DAD1E03F6F79DB53D83CD41B \
ENVIRONMENT_NAME="Trade Book (Staging)" \
ALLOW_TOPIC_CREATE=true \
ALLOW_TOPIC_DELETE=true \
ALLOW_TOPIC_EDIT=true \
ALLOW_TOPIC_INSPECT=true \
ALLOW_TOPIC_PRODUCE=true \
java -jar -Xmx2G ./kpow-latest.jar
  • Run chmod +x start-kpow.sh then ./start-kpow.sh

  • kPow is now running on http://localhost:3000

Java Commands

In general we recommend starting kPow with a Java command similar to our Dockerfile:

java -jar -Xmx2G ./kpow-latest.jar

However java -jar strips any classpath parameters you pass to the command which might be a problem in certain installation cases or when configuring Custom Serdes.

To pass extra classpath parameters to kPow, or simply to start with the plain java command you can:

java -Xmx2G -cp ./kpow-latest.jar:another.jar operatr.kpow