isabella232 / kafka-minion-helm-chart

Helm chart for deployment of Kafka Minion

Kafka Minion Helm Chart

Helm chart for deployment of Kafka Minion

Intalling helm chart

helm repo add kafka-minion https://raw.githubusercontent.com/cloudworkz/kafka-minion-helm-chart/master
helm repo update
helm install --name=kafka-minion kafka-minion/kafka-minion

Chart configuration

NOTE: You may want to adapt the readiness probe values depending on your kafka cluster size. To ensure high availability during rolling updates Kafka Minion marks itself ready only after it has completely processed the __consumer_offsets topic. By default it has up to 10 minutes and 10 seconds to do so, then it's getting killed by Kubernetes.

Parameter	Description	Default
telemetry.host	Host for prometheus server to to listen on	0.0.0.0
telemetry.port	Port for prometheus server to listen on	8080
logLevel	Logger's log granularity (debug, info, warn, error, fatal, panic)	info
livenessProbe.initialDelaySeconds	Number of seconds after the container has started before liveness or readiness probes are initiated	10
livenessProbe.periodSeconds	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.	10
livenessProbe.timeoutSeconds	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1	5
livenessProbe.failureThreshold	When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Minimum value is 1.	60
readinessProbe.initialDelaySeconds	Number of seconds after the container has started before liveness or readiness probes are initiated	10
readinessProbe.periodSeconds	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.	10
readinessProbe.timeoutSeconds	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1	5
readinessProbe.failureThreshold	When a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Minimum value is 1.	60
podSecurityContext.runAsUser	UserID to use for the pod	99
podSecurityContext.fsGroup	User group to use for the pod	99
containerSecurityContext	Security Context for the kafka minion container	{}
kafka.brokers	Comma delimited list of brokers to connect to	(none)
kafka.sasl.enabled	Bool to enable/disable SASL authentication (only SASL_PLAINTEXT is supported)	false
kafka.sasl.useHandshake	Whether or not to send the Kafka SASL handshake first	true
kafka.sasl.credentials.existingSecret	Secretname of an existing secret which contains SASL credentials	(none)
kafka.sasl.credentials.username	SASL username	(none)
kafka.sasl.credentials.password	SASL password	(none)
kafka.tls.enabled	Whether or not to use TLS when connecting to the broker	false
kafka.tls.insecureSkipTlsVerify	If true, TLS accepts any certificate presented by the server and any host name in that certificate.	true
kafka.tls.certificates.existingSecret	Secretname of an existing secret which contains TLS certificates	(none)
kafka.tls.certificates.ca	TLS CA	(none)
kafka.tls.certificates.cert	TLS Cert	(none)
kafka.tls.certificates.key	TLS Key	(none)
kafka.tls.certificates.passphrase	Key to decrypt TLS key	(none)
serviceMonitor.create	Whether or not to create a service monitor for prometheus operator	false
serviceMonitor.interval	Scrape interval for prometheus operator	10s
serviceMonitor.scrapeTimeout	Scrape timeout for prometheus operator	10s
serviceMonitor.releaseLabel	Release label being used for prometheus operator selector	prometheus-operator
serviceMonitor.additionalLabels	Additional labels to add to the ServiceMonitor	(none)
serviceMonitor.relabelings	RelabelConfigs to add to the ServiceMonitor	(none)
podAnnotations	Pod annotations	{}
podLabels	Pod labels	{}
priorityClassName	Priority Class to be used by the pod	""
podSecurityPolicy.enabled	Enable/disable PodSecurityPolicy and associated Role/Rolebinding creation	false
serviceAccount.create	Create a ServiceAccount for the pod	false
serviceAccount.imagePullSecrets	Image pull secrets that should be configured on the service account	[]
serviceAccount.name	Name of a ServiceAccount to use that is not handled by this chart	default

SASL/SSL Setup

When configuring SASL or TLS you can either provide the secretname of an existing secret or pass the contents as values. When you choose to create the secrets on your own, please make sure you comply with the key names used in this chart:

SASL

Key names are username and password.

type: Opaque
data:
  username:
  password:

TLS

Key names are tls.ca, tls.key, tls.crt and passphrase.

type: Opaque
data:
  tls.ca:
  tls.key:
  tls.crt:
  passphrase: