Skip to content
Klag Klag

Kubernetes (Helm)

The official Helm chart is the recommended way to run Klag on Kubernetes. It is published to a Helm repository served from GitHub Pages and indexed on Artifact Hub.

Install

Section titled “Install”
Terminal window
helm repo add klag https://themoah.github.io/klag
helm repo update
helm search repo klag   # find the latest version


helm install klag klag/klag \
  --set kafka.bootstrapServers="kafka-broker:9092"

Pin a version with --version, e.g. --version 0.1.12.

With SASL authentication

Section titled “With SASL authentication”
Terminal window
helm install klag klag/klag \
  --set kafka.bootstrapServers="kafka:9092" \
  --set kafka.securityProtocol="SASL_SSL" \
  --set kafka.saslMechanism="PLAIN" \
  --set kafka.saslJaasConfig="org.apache.kafka.common.security.plain.PlainLoginModule required username='user' password='pass';"

From a local checkout (development)

Section titled “From a local checkout (development)”
Terminal window
helm install klag ./charts/klag \
  --set kafka.bootstrapServers="kafka-broker:9092"

Configuration

Section titled “Configuration”

The chart exposes Kafka connection, metrics reporter, resource limits, and (optionally) a ServiceMonitor for the Prometheus Operator. See the chart README for the full list of values, and the Configuration Reference for the underlying environment variables.

Permissions

Section titled “Permissions”

Klag needs only read-only Kafka access. See ACL Permissions. On Kubernetes-managed Kafka, Strimzi is fully supported.