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.
1
## The Kafka Bootstrap URL for your cluster (Required).
2
BOOTSTRAP=kafka-1:9092,kafka-2:9092,kafka-3:9092
3
4
## Your license details (Required).
5
## These parameters can be cut/paste from your license email
6
LICENSE_ID=1c99v4-f690-4a4f-b144-73de2369444a
7
LICENSE_CODE=TRIAL_30D
8
LICENSEE=My Corp
9
LICENSE_EXPIRY=2020-09-05
10
LICENSE_SIGNATURE=15CFFF969111DB6DCA142B6F1E0065F94A614251B80128D52C2CD45993A021AE10E90F57B90FF76CC1B992C16E54BCF1CBE7E5EE3124B3E585BE133774836A6EBB51B55E67EF60F4A435EBEC9F07A26CEABDCF6E3CF4137A33201E7662AF1F7986E57341E0EAEB884BBF320C348D62679F521259DAD1E03F6F79DB53D83CD41B
11
12
## Optional from here:
13
14
## Name your Operatr installation (this appears in the UI)
15
ENVIRONMENT_NAME=Trade Book (Staging)
16
17
## Operatr Feature Flags (See: RBAC for per user controls):
18
19
## Allow users to create new topics
20
ALLOW_TOPIC_CREATE=true
21
22
## Allow users to delete topics
23
ALLOW_TOPIC_DELETE=true
24
25
## Allow users to edit topic configuration
26
ALLOW_TOPIC_EDIT=true
27
28
## Allow users to view topic data
29
ALLOW_TOPIC_INSPECT=true
30
31
## Allow users to produce messages to topics
32
ALLOW_TOPIC_PRODUCE=true
33
34
## ... etc (see guide for more configuration flags).
Copied!
  • Start the latest kPow container with your config.env file.
1
docker run -p 3000:3000 -m2G --env-file ./config.env operatr/kpow:latest
Copied!
  • 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.
1
BOOTSTRAP="kafka-1:9092,kafka-2:9092,kafka-3:9092" \
2
LICENSE_ID=1c99v4-f690-4a4f-b144-73de2369444a \
3
LICENSE_CODE=TRIAL_30D \
4
LICENSEE="My Corp" \
5
LICENSE_EXPIRY=2020-09-05 \
6
LICENSE_SIGNATURE=15CFFF969111DB6DCA142B6F1E0065F94A614251B80128D52C2CD45993A021AE10E90F57B90FF76CC1B992C16E54BCF1CBE7E5EE3124B3E585BE133774836A6EBB51B55E67EF60F4A435EBEC9F07A26CEABDCF6E3CF4137A33201E7662AF1F7986E57341E0EAEB884BBF320C348D62679F521259DAD1E03F6F79DB53D83CD41B \
7
ENVIRONMENT_NAME="Trade Book (Staging)" \
8
ALLOW_TOPIC_CREATE=true \
9
ALLOW_TOPIC_DELETE=true \
10
ALLOW_TOPIC_EDIT=true \
11
ALLOW_TOPIC_INSPECT=true \
12
ALLOW_TOPIC_PRODUCE=true \
13
java -jar -Xmx2G ./kpow-latest.jar
Copied!
  • 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:
1
java -jar -Xmx2G ./kpow-latest.jar
Copied!
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:
1
java -Xmx2G -cp ./kpow-latest.jar:another.jar operatr.kpow
Copied!
Last modified 3mo ago