kpow-helm-charts

Run Kpow for Apache Kafka in Kubernetes

This is the Kpow for Apache Kafka® Helm Charts Repository, published at https://charts.kpow.io.

Helm is the package manager for Kubernetes.

Kpow is the all-in-one toolkit to manage, monitor, and learn about your Kafka resources.

View this repository and associated charts on ArtifactHUB.

Helm Charts

This repository currently contains a single Helm chart that uses the factorhouse/kpow-ee container from Dockerhub.

Prerequisites

To run the Dockerhub container requires a license. Start a free 30-day trial of Kpow today.

See Kpow on the AWS Marketplace to have Kpow billed automatically to your AWS account, no license required.

Installation

You need to connect to a Kubernetes environment before you can install Kpow.

The following examples demonstrate installing Kpow in Amazon EKS.

Configure Kubernetes/EKS

aws eks --region <your-aws-region> update-kubeconfig --name <your-eks-cluster-name>

Updated context arn:aws:eks:<your-aws-region>:123123123:cluster/<your-eks-cluster-name> in /your/.kube/config

Confirm Kubernetes Cluster Availability

kubectl get svc

NAME         TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)   AGE
kubernetes   ClusterIP   12.345.6.7   <none>        443/TCP   28h

Run Kpow in Kubernetes

Configure the Kpow Helm Repository

Add the Helm Repository in order to use the Kpow Helm Chart.

helm repo add kpow https://charts.kpow.io

Update Helm repositories to ensure you install the latest version of Kpow.

helm repo update

Start a Kpow Instance

The minimum information required by Kpow to operate is:

• License Details
• Kafka Bootstrap URL

See the Kpow Documentation for a full list of configuration options.

Start Kpow with config from ‘–set env.XYZ’

Quotation

Some fields require quoting of characters within the value-string when using –set env.XXX to pass configuration .

This particularly applies to commas, integers, and quotation marks (see examples below).

Command

Note, when using --set you may need to escape special characters with \, see:

https://helm.sh/docs/intro/using_helm/#the-format-and-limitations-of-set

Use the following to install from command line:

helm install --namespace factorhouse --create-namespace kpow kpow/kpow \
  --set env.LICENSE_ID="00000000-0000-0000-0000-000000000001" \
  --set env.LICENSE_CODE="KPOW_CREDIT" \
  --set env.LICENSEE="Factor House\, Inc." \ <-- note the quoted comma
  --set env.LICENSE_EXPIRY="2022-01-01" \
  --set env.LICENSE_SIGNATURE="638......A51" \
  --set env.BOOTSTRAP="127.0.0.1:9092\,127.0.0.1:9093\,127.0.0.1:9094" \ <-- note the quoted commas
  --set env.SECURITY_PROTOCOL="SASL_PLAINTEXT" \
  --set env.SASL_MECHANISM="PLAIN" \
  --set env.SASL_JAAS_CONFIG="org.apache.kafka.common.security.plain.PlainLoginModule required username=\"user\" password=\"secret\";" \ <-- note the quoted quotes
  --set env.LICENSE_CREDITS="7"

NAME: kpow
LAST DEPLOYED: Mon May 31 17:22:21 2021
NAMESPACE: factorhouse
STATUS: deployed
REVISION: 1
NOTES:
1. Get the application URL by running these commands:
  export POD_NAME=$(kubectl get pods --namespace factorhouse -l "app.kubernetes.io/name=kpow,app.kubernetes.io/instance=kpow" -o jsonpath="{.items[0].metadata.name}")
  echo "Visit http://127.0.0.1:3000 to use your application"
  kubectl --namespace factorhouse port-forward $POD_NAME 3000:3000

Start Kpow with config from a ConfigMap

You can configure Kpow with a ConfigMap of environment variables as follows:

helm install --namespace factorhouse --create-namespace kpow kpow/kpow --set envFromConfigMap=kpow-config

See kpow-config.yaml.example for example environment configuration file.

Access the Kpow UI

Follow the instructions in the notes to configure port forwarding.

export POD_NAME=$(kubectl get pods --namespace factorhouse -l "app.kubernetes.io/name=kpow,app.kubernetes.io/instance=kpow" -o jsonpath="{.items[0].metadata.name}")
echo "Visit http://127.0.0.1:3000 to use your application"
kubectl --namespace factorhouse port-forward $POD_NAME 3000:3000

Kpow is now available on http://127.0.0.1:3000.

Check the Kpow Pod

kubectl describe pods --namespace factorhouse

Name:         kpow-9988df6b6-vvf8z
Namespace:    factorhouse
Priority:     0
Node:         ip-172-31-33-42.ap-southeast-2.compute.internal/172.31.33.42
Start Time:   Mon, 31 May 2021 17:22:22 +1000
Labels:       app.kubernetes.io/instance=kpow
              app.kubernetes.io/name=kpow
              pod-template-hash=9988df6b6
Annotations:  kubernetes.io/psp: eks.privileged
Status:       Running

View the Kpow Pod Logs

kubectl logs --namespace factorhouse kpow-9988df6b6-vvf8z 

11:36:49.111 INFO  [main] operatr.system ? start Kpow
...

Remove Kpow

helm delete --namespace factorhouse kpow

Get Help!

If you have any issues or errors, please contact [email protected].

Licensing and Modifications

This repository is Apache 2.0 licensed, you are welcome to clone and modify as required.

This site is open source. Improve this page.