Kafka 绑定规范
关于 Kafka 绑定组件的详细文档
组件格式
要配置 Kafka 绑定,需创建一个 bindings.kafka
类型的组件。请参考本指南了解如何创建和应用绑定配置。有关使用 secretKeyRef
的详细信息,请查看如何在组件中引用 secret的指南。
所有组件的元数据字段值可以使用模板化的元数据值,这些值会在 Dapr sidecar 启动时进行解析。例如,您可以选择使用 {namespace}
作为 consumerGroup
,以便在不同命名空间中使用相同的 appId
和主题,如本文中所述。
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: kafka-binding
spec:
type: bindings.kafka
version: v1
metadata:
- name: topics # 可选。用于输入绑定。
value: "topic1,topic2"
- name: brokers # 必需。
value: "localhost:9092,localhost:9093"
- name: consumerGroup # 可选。用于输入绑定。
value: "group1"
- name: publishTopic # 可选。用于输出绑定。
value: "topic3"
- name: authRequired # 必需。
value: "true"
- name: saslUsername # 如果 authRequired 为 `true`,则必需。
value: "user"
- name: saslPassword # 如果 authRequired 为 `true`,则必需。
secretKeyRef:
name: kafka-secrets
key: "saslPasswordSecret"
- name: saslMechanism
value: "SHA-512"
- name: initialOffset # 可选。用于输入绑定。
value: "newest"
- name: maxMessageBytes # 可选。
value: "1024"
- name: heartbeatInterval # 可选。
value: 5s
- name: sessionTimeout # 可选。
value: 15s
- name: version # 可选。
value: "2.0.0"
- name: direction
value: "input, output"
- name: schemaRegistryURL # 可选。当使用 Schema Registry Avro 序列化/反序列化时。Schema Registry URL。
value: http://localhost:8081
- name: schemaRegistryAPIKey # 可选。当使用 Schema Registry Avro 序列化/反序列化时。Schema Registry API Key。
value: XYAXXAZ
- name: schemaRegistryAPISecret # 可选。当使用 Schema Registry Avro 序列化/反序列化时。Schema Registry 凭证 API Secret。
value: "ABCDEFGMEADFF"
- name: schemaCachingEnabled # 可选。当使用 Schema Registry Avro 序列化/反序列化时。启用 schema 缓存。
value: true
- name: schemaLatestVersionCacheTTL # 可选。当使用 Schema Registry Avro 序列化/反序列化时。发布消息时使用最新 schema 的缓存 TTL。
value: 5m
- name: escapeHeaders # 可选。
value: false
规范元数据字段
字段 | 必需 | 绑定支持 | 详情 | 示例 |
---|---|---|---|---|
topics |
N | 输入 | 逗号分隔的主题字符串。 | "mytopic1,topic2" |
brokers |
Y | 输入/输出 | 逗号分隔的 Kafka brokers 字符串。 | "localhost:9092,dapr-kafka.myapp.svc.cluster.local:9093" |
clientID |
N | 输入/输出 | 用户提供的字符串,随每个请求发送到 Kafka brokers 以用于日志记录、调试和审计。 | "my-dapr-app" |
consumerGroup |
N | 输入 | 监听的 kafka 消费者组。发布到主题的每条记录都会传递给订阅该主题的每个消费者组中的一个消费者。 | "group1" |
consumeRetryEnabled |
N | 输入/输出 | 通过设置为 "true" 启用消费重试。在 Kafka 绑定组件中默认为 false 。 |
"true" , "false" |
publishTopic |
Y | 输出 | 要发布到的主题。 | "mytopic" |
authRequired |
N | 已弃用 | 启用与 Kafka brokers 的 SASL 认证。 | "true" , "false" |
authType |
Y | 输入/输出 | 配置或禁用认证。支持的值:none 、password 、mtls 或 oidc |
"password" , "none" |
saslUsername |
N | 输入/输出 | 用于认证的 SASL 用户名。仅当 authRequired 设置为 "true" 时需要。 |
"adminuser" |
saslPassword |
N | 输入/输出 | 用于认证的 SASL 密码。可以是 secretKeyRef 以使用secret 引用。仅当 authRequired 设置为 "true" 时需要。 |
"" , "KeFg23!" |
saslMechanism |
N | 输入/输出 | 您想要使用的 SASL 认证机制。仅当 authtype 设置为 "password" 时需要。如果未提供,默认为 PLAINTEXT ,这可能会导致某些服务(如 Amazon Managed Service for Kafka)中断。 |
"SHA-512", "SHA-256", "PLAINTEXT" |
initialOffset |
N | 输入 | 如果之前没有提交偏移量,则使用的初始偏移量。应为 “newest” 或 “oldest”。默认为 “newest”。 | "oldest" |
maxMessageBytes |
N | 输入/输出 | 单个 Kafka 消息允许的最大字节大小。默认为 1024。 | "2048" |
oidcTokenEndpoint |
N | 输入/输出 | OAuth2 身份提供者访问令牌端点的完整 URL。当 authType 设置为 oidc 时需要 |
“https://identity.example.com/v1/token" |
oidcClientID |
N | 输入/输出 | 在身份提供者中配置的 OAuth2 客户端 ID。当 authType 设置为 oidc 时需要 |
"dapr-kafka" |
oidcClientSecret |
N | 输入/输出 | 在身份提供者中配置的 OAuth2 客户端 secret:当 authType 设置为 oidc 时需要 |
"KeFg23!" |
oidcScopes |
N | 输入/输出 | 逗号分隔的 OAuth2/OIDC 范围列表,用于请求访问令牌。当 authType 设置为 oidc 时推荐。默认为 "openid" |
"openid,kafka-prod" |
version |
N | 输入/输出 | Kafka 集群版本。默认为 2.0.0。请注意,对于使用 Kafka 的 EventHubs,必须将其设置为 1.0.0 。 |
"1.0.0" |
direction |
N | 输入/输出 | 绑定的方向。 | "input" , "output" , "input, output" |
oidcExtensions |
N | 输入/输出 | 包含 JSON 编码的 OAuth2/OIDC 扩展字典的字符串,用于请求访问令牌 | {"cluster":"kafka","poolid":"kafkapool"} |
schemaRegistryURL |
N | 使用 Schema Registry Avro 序列化/反序列化时必需。Schema Registry URL。 | http://localhost:8081 |
|
schemaRegistryAPIKey |
N | 使用 Schema Registry Avro 序列化/反序列化时。Schema Registry 凭证 API Key。 | XYAXXAZ |
|
schemaRegistryAPISecret |
N | 使用 Schema Registry Avro 序列化/反序列化时。Schema Registry 凭证 API Secret。 | ABCDEFGMEADFF |
|
schemaCachingEnabled |
N | 使用 Schema Registry Avro 序列化/反序列化时。启用 schema 缓存。默认为 true |
true |
|
schemaLatestVersionCacheTTL |
N | 使用 Schema Registry Avro 序列化/反序列化时。发布消息时使用最新 schema 的缓存 TTL。默认为 5 分钟 | 5m |
|
clientConnectionTopicMetadataRefreshInterval |
N | 输入/输出 | 客户端连接的主题元数据与 broker 刷新的间隔,以 Go 持续时间表示。默认为 9m 。 |
"4m" |
clientConnectionKeepAliveInterval |
N | 输入/输出 | 客户端连接与 broker 保持活动的最长时间,以 Go 持续时间表示,然后关闭连接。零值(默认)表示无限期保持活动。 | "4m" |
consumerFetchDefault |
N | 输入/输出 | 每个请求从 broker 获取的默认消息字节数。默认为 "1048576" 字节。 |
"2097152" |
heartbeatInterval |
N | 输入 | 向消费者协调器发送心跳的间隔。最多应设置为 sessionTimeout 值的 1/3。默认为 "3s" 。 |
"5s" |
sessionTimeout |
N | 输入 | 使用 Kafka 的组管理功能时用于检测客户端故障的超时时间。如果 broker 在此会话超时之前未收到任何来自消费者的心跳,则消费者将被移除并启动重新平衡。默认为 "10s" 。 |
"20s" |
escapeHeaders |
N | 输入 | 启用对消费者接收的消息头值的 URL 转义。允许接收通常不允许在 HTTP 头中的特殊字符内容。默认为 false 。 |
true |
注意
使用 Azure EventHubs 和 Kafka 时,元数据 version
必须设置为 1.0.0
。
绑定支持
此组件支持 输入和输出 绑定接口。
此组件支持具有以下操作的 输出绑定:
create
认证
Kafka 支持多种认证方案,Dapr 支持几种:SASL 密码、mTLS、OIDC/OAuth2。了解更多关于 Kafka 绑定和 Kafka pub/sub 组件的认证方法。
指定分区键
调用 Kafka 绑定时,可以通过请求体中的 metadata
部分提供可选的分区键。
字段名称为 partitionKey
。
示例:
curl -X POST http://localhost:3500/v1.0/bindings/myKafka \
-H "Content-Type: application/json" \
-d '{
"data": {
"message": "Hi"
},
"metadata": {
"partitionKey": "key1"
},
"operation": "create"
}'
响应
如果成功,将返回 HTTP 204(无内容)和空响应体。
相关链接
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.