Apache Kafka

Detailed documentation on the Apache Kafka pubsub component

Component format

To setup Apache Kafka pubsub create a component of type pubsub.kafka. See this guide on how to create and apply a pubsub configuration. For details on using secretKeyRef, see the guide on how to reference secrets in components.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: kafka-pubsub
  5.   namespace: default
  6. spec:
  7.   type: pubsub.kafka
  8.   version: v1
  9.   metadata:
  10.   - name: brokers # Required. Kafka broker connection setting
  11.     value: "dapr-kafka.myapp.svc.cluster.local:9092"
  12.   - name: consumerGroup # Optional. Used for input bindings.
  13.     value: "group1"
  14.   - name: clientID # Optional. Used as client tracing ID by Kafka brokers.
  15.     value: "my-dapr-app-id"
  16.   - name: authRequired # Required.
  17.     value: "true"
  18.   - name: saslUsername # Required if authRequired is `true`.
  19.     value: "adminuser"
  20.   - name: saslPassword # Required if authRequired is `true`.
  21.     secretKeyRef:
  22.       name: kafka-secrets
  23.       key: saslPasswordSecret
  24.   - name: maxMessageBytes # Optional.
  25.     value: 1024

Spec metadata fields

FieldRequiredDetailsExample
brokersYA comma-separated list of Kafka brokers.“localhost:9092,dapr-kafka.myapp.svc.cluster.local:9093”
consumerGroupNA kafka consumer group to listen on. Each record published to a topic is delivered to one consumer within each consumer group subscribed to the topic.“group1”
clientIDNA user-provided string sent with every request to the Kafka brokers for logging, debugging, and auditing purposes. Defaults to “sarama”.“my-dapr-app”
authRequiredYEnable SASL authentication with the Kafka brokers.“true”, “false”
saslUsernameNThe SASL username used for authentication. Only required if authRequired is set to “true”.“adminuser”
saslPasswordNThe SASL password used for authentication. Can be secretKeyRef to use a secret reference. Only required if authRequired is set to “true”.“”, “KeFg23!”
maxMessageBytesNThe maximum size in bytes allowed for a single Kafka message. Defaults to 1024.2048

Per-call metadata fields

Partition Key

When invoking the Kafka pub/sub, its possible to provide an optional partition key by using the metadata query param in the request url.

The param name is partitionKey.

Example:

  1. curl -X POST http://localhost:3500/v1.0/publish/myKafka/myTopic?metadata.partitionKey=key1 \
  2.   -H "Content-Type: application/json" \
  3.   -d '{
  4.         "data": {
  5.           "message": "Hi"
  6.         }
  7.       }'

Create a Kafka instance

You can run Kafka locally using this Docker image. To run without Docker, see the getting started guide here.

To run Kafka on Kubernetes, you can use any Kafka operator, such as Strimzi.

Last modified September 17, 2021 : Merge pull request #1757 from georgestevens99/1440SecretKeyRefExplanation (620a5f8)