将事件发布到 Kafka
MinIO 支持将 存储桶通知 事件发布到 Kafka 服务端点。
MinIO 依赖于 https://github.com/Shopify/sarama 项目进行 Kafka 连接,并共享该项目的 Kafka 支持。有关更多详细信息,请参见 sarama
兼容性和 API 稳定性 部分。
向 MinIO 部署添加 Kafka 端点
以下步骤添加了一个新的 Kafka 服务端点,用于支持 MinIO 部署中的 存储桶通知。
先决条件
Kafka 最低版本和支持的版本
MinIO 依赖于 https://github.com/Shopify/sarama 项目进行 Kafka 连接,并共享该项目的 Kafka 支持。有关更多详细信息,请参见 sarama
兼容性和 API 稳定性 部分。
MinIO mc
命令行工具
1) 将 Kafka 端点添加到 MinIO
您可以使用环境变量或通过设置运行时配置设置来配置新的 Kafka 服务端点。
MinIO 支持使用 环境变量 指定 Kafka 服务端点和相关配置设置。 minio server
进程将在下次启动时应用指定的设置。
以下示例代码设置了与配置 Kafka 服务端点相关的所有环境变量。最小必需变量是 MINIO_NOTIFY_KAFKA_ENABLE
和 MINIO_NOTIFY_KAFKA_BROKERS
set MINIO_NOTIFY_KAFKA_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_KAFKA_BROKERS_<IDENTIFIER>="<ENDPOINT>"
set MINIO_NOTIFY_KAFKA_TOPIC_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_SASL_USERNAME_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_SASL_PASSWORD_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_SASL_MECHANISM_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_TLS_CLIENT_AUTH_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_SASL_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_TLS_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_TLS_SKIP_VERIFY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_CLIENT_TLS_CERT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_CLIENT_TLS_KEY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_VERSION_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_COMMENT_<IDENTIFIER>="<string>"
将
<IDENTIFIER>
替换为 Kafka 服务端点的唯一描述性字符串。对于与新目标服务端点相关的所有环境变量,使用相同的<IDENTIFIER>
值。以下示例假设标识符为PRIMARY
。如果指定的
<IDENTIFIER>
与 MinIO 部署中现有的 Kafka 服务端点匹配,新设置将 *覆盖* 该端点的任何现有设置。使用mc admin config get notify_kafka
查看当前 MinIO 部署中配置的 Kafka 端点。用逗号分隔的 Kafka 代理列表替换
<ENDPOINT>
。例如"kafka1.example.com:2021,kafka2.example.com:2021"
有关每个环境变量的完整文档,请参阅 用于桶通知的 Kafka 服务。
MinIO 支持使用 mc admin config set
命令和 notify_kafka
配置键在运行的 minio server
进程中添加或更新 Kafka 端点。您必须重新启动 minio server
进程才能应用任何新的或更新的配置设置。
以下示例代码设置了与配置 Kafka 服务端点相关的 *所有* 设置。*必需* 的最小设置是 notify_kafka brokers
mc admin config set ALIAS/ notify_kafka:IDENTIFIER \
brokers="<ENDPOINT>" \
topic="<string>" \
sasl_username="<string>" \
sasl_password="<string>" \
sasl_mechanism="<string>" \
tls_client_auth="<string>" \
tls="<string>" \
tls_skip_verify="<string>" \
client_tls_cert="<string>" \
client_tls_key="<string>" \
version="<string>" \
queue_dir="<string>" \
queue_limit="<string>" \
comment="<string>"
用 Kafka 服务端点的唯一描述性字符串替换
IDENTIFIER
。此过程中的以下示例假设标识符为PRIMARY
。如果指定的
IDENTIFIER
与 MinIO 部署中现有的 Kafka 服务端点匹配,新设置将 *覆盖* 该端点的任何现有设置。使用mc admin config get notify_kafka
查看当前 MinIO 部署中配置的 Kafka 端点。用逗号分隔的 Kafka 代理列表替换
ENDPOINT
。例如"kafka1.example.com:2021,kafka2.example.com:2021"
有关每个设置的完整文档,请参阅 Kafka 桶通知配置设置。
2) 重新启动 MinIO 部署
您必须重新启动 MinIO 部署才能应用配置更改。使用 mc admin service restart
命令重新启动部署。
mc admin service restart ALIAS
用要重新启动的部署的 别名 替换 ALIAS
。
minio server
进程在启动时为每个配置的 Kafka 目标打印一行,类似于以下内容
SQS ARNs: arn:minio:sqs::primary:kafka
您必须在使用关联的 Kafka 部署作为目标配置桶通知时指定 ARN 资源。
识别您的桶通知的 ARN
您之前在创建端点时定义了要分配给桶通知目标 ARN 的 <IDENTIFIER>
。以下步骤返回部署中配置的 ARN。通过查找您指定的 <IDENTIFIER>
来识别之前创建的 ARN。
查看 JSON 输出
复制并运行以下命令,将
ALIAS
替换为部署的 别名。mc admin info --json ALIAS
在 JSON 输出中,查找键
info.sqsARN
。您需要的 ARN 是与您指定的
<IDENTIFIER>
匹配的该键的值。例如,
arn:minio:sqs::primary:kafka
。
使用 jq 解析 JSON 以获取值
3) 使用 Kafka 端点作为目标配置桶通知
使用 mc event add
命令添加一个新的桶通知事件,并将配置的 Kafka 服务作为目标
mc event add ALIAS/BUCKET arn:minio:sqs::primary:kafka \
--event EVENTS
使用 mc event ls
查看为给定通知目标配置的所有桶事件
mc event ls ALIAS/BUCKET arn:minio:sqs::primary:kafka
4) 验证配置的事件
对您为其配置新事件的桶执行操作,并在 Kafka 服务中检查通知数据。所需的操作取决于配置桶通知时指定的 事件
。
例如,如果桶通知配置包含 s3:ObjectCreated:Put
事件,您可以使用 mc cp
命令在桶中创建新的对象并触发通知。
mc cp ~/data/new-object.txt ALIAS/BUCKET
更新 MinIO 部署中的 Kafka 端点
以下过程更新了现有的 Kafka 服务端点,以支持 MinIO 部署中的 桶通知。
先决条件
Kafka 最小版本和支持版本
MinIO 依赖于 https://github.com/Shopify/sarama 项目进行 Kafka 连接,并共享该项目的 Kafka 支持。有关更多详细信息,请参见 sarama
兼容性和 API 稳定性 部分。
MinIO mc
命令行工具
1) 列出部署中配置的 Kafka 端点
使用 mc admin config get
命令列出部署中当前配置的 Kafka 服务端点
mc admin config get ALIAS/ notify_kafka
用 MinIO 部署的 别名 替换 ALIAS
。
命令输出类似于以下内容
notify_kafka:primary tls_skip_verify="off" queue_dir="" queue_limit="0" sasl="off" sasl_password="" sasl_username="" tls_client_auth="0" tls="off" brokers="" topic="" client_tls_cert="" client_tls_key="" version=""
notify_kafka:secondary tls_skip_verify="off" queue_dir="" queue_limit="0" sasl="off" sasl_password="" sasl_username="" tls_client_auth="0" tls="off" brokers="" topic="" client_tls_cert="" client_tls_key="" version=""
notify_kafka
键是 Kafka 通知设置 的顶级配置键。 brokers
键指定给定 notify_kafka 键的 Kafka 服务端点。 notify_kafka:<IDENTIFIER>
后缀描述了该 Kafka 服务端点的唯一标识符。
注意您要为下一步更新的 Kafka 服务端点的标识符。
2) 更新 Kafka 端点
使用 mc admin config set
命令设置 Kafka 服务端点的新的配置
mc admin config set ALIAS/ notify_kafka:<IDENTIFIER> \
brokers="https://kafka1.example.net:9200, https://kafka2.example.net:9200" \
topic="<string>" \
sasl_username="<string>" \
sasl_password="<string>" \
sasl_mechanism="<string>" \
tls_client_auth="<string>" \
tls="<string>" \
tls_skip_verify="<string>" \
client_tls_cert="<string>" \
client_tls_key="<string>" \
version="<string>" \
queue_dir="<string>" \
queue_limit="<string>" \
comment="<string>"
notify_kafka brokers
配置设置是 Kafka 服务端点的 *必需* 的 *最小* 设置。所有其他配置设置都是 *可选* 的。有关 Kafka 配置设置的完整列表,请参阅 Kafka 通知设置。
3) 重新启动 MinIO 部署
您必须重新启动 MinIO 部署才能应用配置更改。使用 mc admin service restart
命令重新启动部署。
mc admin service restart ALIAS
用要重新启动的部署的 别名 替换 ALIAS
。
minio server
进程在启动时为每个配置的 Kafka 目标打印一行,类似于以下内容
SQS ARNs: arn:minio:sqs::primary:kafka
4) 验证更改
对具有使用更新的 Kafka 服务端点的事件配置的桶执行操作,并在 Kafka 服务中检查通知数据。所需的操作取决于配置桶通知时指定的 事件
。
例如,如果桶通知配置包含 s3:ObjectCreated:Put
事件,您可以使用 mc cp
命令在桶中创建新的对象并触发通知。
mc cp ~/data/new-object.txt ALIAS/BUCKET