文档

将事件发布到 MQTT

MinIO 支持将 存储桶通知 事件发布到 MQTT 服务器/代理端点。

将 MQTT 端点添加到 MinIO 部署

以下步骤添加了一个新的 MQTT 服务端点,用于支持 MinIO 部署中的 存储桶通知

先决条件

MQTT 3.1 或 3.1.1 服务器/代理

此步骤假设存在一个现有的 MQTT 3.1 或 3.1.1 服务器/代理,MinIO 部署可以连接到该服务器/代理。有关 MQTT 兼容服务器/代理的列表,请参阅 mqtt.org 软件列表

如果 MQTT 服务需要身份验证,则在配置过程中必须提供相应的用户名和密码,以授予 MinIO 访问服务的权限。

MinIO mc 命令行工具

此步骤使用 mc 命令行工具执行某些操作。有关安装说明,请参阅 mc 快速入门

1) 将 MQTT 端点添加到 MinIO

您可以使用环境变量通过设置运行时配置设置来配置新的 MQTT 服务端点。

MinIO 支持使用 环境变量 指定 MQTT 服务端点和关联的配置设置。 minio server 进程将在下次启动时应用指定的设置。

以下示例代码设置了与配置 MQTT 服务端点相关的所有环境变量。必需的最小变量是

set MINIO_NOTIFY_MQTT_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_MQTT_BROKER_<IDENTIFIER>="ENDPOINT"
set MINIO_NOTIFY_MQTT_TOPIC_<IDENTIFIER>="TOPIC"
set MINIO_NOTIFY_MQTT_USERNAME_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_MQTT_PASSWORD_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_MQTT_QOS_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_MQTT_KEEP_ALIVE_INTERVAL_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_MQTT_RECONNECT_INTERVAL_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_MQTT_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_MQTT_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_MQTT_COMMENT_<IDENTIFIER>="<string>"
  • <IDENTIFIER> 替换为 MQTT 服务端点的唯一描述性字符串。为所有与新 MQTT 服务端点相关的环境变量使用相同的 <IDENTIFIER> 值。以下示例假设标识符为 PRIMARY

    如果指定的 <IDENTIFIER> 与 MinIO 部署中现有的 MQTT 服务端点匹配,则新设置将覆盖该端点的任何现有设置。使用 mc admin config get notify_mqtt 检查 MinIO 部署中当前配置的 MQTT 端点。

  • <ENDPOINT> 替换为 MQTT 服务端点的 URL。例如

    tcp://hostname:port

  • TOPIC 替换为 MinIO 将发布到服务器/代理的事件关联到的 MQTT 主题。

有关每个环境变量的完整文档,请参阅 MQTT Service for Bucket Notifications

MinIO 支持使用 mc admin config set 命令和 notify_mqtt 配置键,在运行的 minio server 进程中添加或更新 MQTT 端点。您必须重新启动 minio server 进程才能应用任何新的或更新的配置设置。

以下示例代码设置了与配置 MQTT 服务端点相关的所有设置。以下配置设置是 MQTT 服务器/代理端点所需的最少设置

  • 代理

  • 主题

  • username 如果 MQTT 服务器/代理强制执行身份验证/授权,则需要

  • password 如果 MQTT 服务器/代理强制执行身份验证/授权,则需要

mc admin config set ALIAS/ notify_mqtt:IDENTIFIER \
   broker="ENDPOINT" \
   topic="TOPIC" \
   username="username" \
   password="password" \
   qos="<integer>" \
   keep_alive_interval="60s|m|h|d"
   reconnect_interval="60s|m|h|d"
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"
  • IDENTIFIER 替换为 MQTT 服务端点的唯一描述性字符串。此过程中的以下示例假设标识符为 PRIMARY

    如果指定的 IDENTIFIER 与 MinIO 部署中现有的 MQTT 服务端点匹配,则新设置将覆盖该端点的任何现有设置。使用 mc admin config get notify_mqtt 检查 MinIO 部署中当前配置的 MQTT 端点。

  • ENDPOINT 替换为 MQTT 服务端点的 URL。例如

    tcp://hostname:port

  • TOPIC 替换为 MinIO 将发布到服务器/代理的事件关联到的 MQTT 主题。

有关每个设置的完整文档,请参阅 MQTT Bucket Notification Configuration Settings

2) 重新启动 MinIO 部署

您必须重新启动 MinIO 部署才能应用配置更改。使用 mc admin service restart 命令重新启动部署。

mc admin service restart ALIAS

ALIAS 替换为要重新启动的部署的 别名

在启动时,minio server 进程会为每个配置的 MQTT 目标打印一行,类似于以下内容

SQS ARNs: arn:minio:sqs::primary:mqtt

使用关联的 MQTT 部署作为目标配置存储桶通知时,您必须指定 ARN 资源。

标识存储桶通知的 ARN

您之前在创建端点时定义了要分配给存储桶通知目标 ARN 的 <IDENTIFIER>。以下步骤将返回部署中配置的 ARN。通过查找您指定的 <IDENTIFIER> 来标识之前创建的 ARN。

查看 JSON 输出

  1. 复制并运行以下命令,将 ALIAS 替换为部署的 别名

    mc admin info --json ALIAS
    
  2. 在 JSON 输出中,查找键 info.sqsARN

    您需要的 ARN 是与您指定的 <IDENTIFIER> 匹配的该键的值。

    例如,arn:minio:sqs::primary:mqtt

使用 jq 解析 JSON 的值

  1. 安装 jq

  2. 复制并运行以下命令,将 ALIAS 替换为部署的 别名

    mc admin info --json ALIAS | jq  .info.sqsARN
    

    这将返回要用于通知的 ARN,例如 arn:minio:sqs::primary:mqtt

1) 使用 MQTT 端点作为目标配置存储桶通知

使用 mc event add 命令添加一个新的存储桶通知事件,并将配置的 MQTT 服务作为目标

mc event add ALIAS/BUCKET arn:minio:sqs::primary:mqtt \
  --event EVENTS
  • ALIAS 替换为 MinIO 部署的 别名

  • BUCKET 替换为要配置事件的存储桶的名称。

  • EVENTS 替换为 事件 的逗号分隔列表,MinIO 将为这些事件触发通知。

使用 mc event ls 查看给定通知目标配置的所有存储桶事件

mc event ls ALIAS/BUCKET arn:minio:sqs::primary:MQTT

4) 验证配置的事件

对您配置了新事件的存储桶执行操作,并检查 MQTT 服务以获取通知数据。所需的操作取决于配置存储桶通知时指定的 事件

例如,如果存储桶通知配置包含 s3:ObjectCreated:Put 事件,您可以使用 mc cp 命令在存储桶中创建新的对象并触发通知。

mc cp ~/data/new-object.txt ALIAS/BUCKET

更新 MinIO 部署中的 MQTT 端点

以下步骤更新现有的 MQTT 服务端点,以支持 MinIO 部署中的 存储桶通知

先决条件

MQTT 3.1 或 3.1.1 服务器/代理端点

此步骤假设存在一个现有的 MQTT 3.1 或 3.1.1 服务器/代理,MinIO 部署可以连接到该服务器/代理。有关 MQTT 兼容服务器/代理的列表,请参阅 mqtt.org 软件列表

如果 MQTT 服务需要身份验证,则在配置过程中必须提供相应的用户名和密码,以授予 MinIO 访问服务的权限。

MinIO mc 命令行工具

此步骤使用 mc 命令行工具执行某些操作。有关安装说明,请参阅 mc 快速入门

1) 列出部署中配置的 MQTT 端点

使用 mc admin config get 命令列出部署中当前配置的 MQTT 服务端点

mc admin config get ALIAS/ notify_mqtt

ALIAS 替换为 MinIO 部署的 别名

命令输出类似于以下内容

notify_mqtt:primary  broker="tcp://mqtt-primary.example.net:port" password="" queue_dir="" queue_limit="0" reconnect_interval="0s"  keep_alive_interval="0s" qos="0" topic="" username=""
notify_mqtt:secondary  broker="tcp://mqtt-primary.example.net:port" password="" queue_dir="" queue_limit="0" reconnect_interval="0s"  keep_alive_interval="0s" qos="0" topic="" username=""

notify_mqttMQTT 通知设置 的顶级配置键。键 broker 指定给定 notify_mqtt 键的 MQTT 服务器/代理端点。后缀 notify_mqtt:<IDENTIFIER> 描述了该 MQTT 服务端点的唯一标识符。

请注意您要为下一步更新的 MQTT 服务端点的标识符。

2) 更新 MQTT 端点

使用 mc admin config set 命令设置 MQTT 服务端点的新的配置

mc admin config set ALIAS/ notify_mqtt:<IDENTIFIER> \
   url="MQTT://user:password@hostname:port" \
   exchange="<string>" \
   exchange_type="<string>" \
   routing_key="<string>" \
   mandatory="<string>" \
   durable="<string>" \
   no_wait="<string>" \
   internal="<string>" \
   auto_deleted="<string>" \
   delivery_mode="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"

以下配置设置是 MQTT 服务器/代理端点的最低要求

  • 代理

  • 主题

  • username 如果 MQTT 服务器/代理强制执行身份验证/授权,则需要

  • password 如果 MQTT 服务器/代理强制执行身份验证/授权,则需要

所有其他配置设置都是可选的。有关 MQTT 配置设置的完整列表,请参阅 MQTT 通知设置

3) 重新启动 MinIO 部署

您必须重新启动 MinIO 部署才能应用配置更改。使用 mc admin service restart 命令重新启动部署。

mc admin service restart ALIAS

ALIAS 替换为要重新启动的部署的 别名

在启动时,minio server 进程会为每个配置的 MQTT 目标打印一行,类似于以下内容

SQS ARNs: arn:minio:sqs::primary:mqtt

3) 验证更改

对使用更新的 MQTT 服务端点具有事件配置的存储桶执行操作,并检查 MQTT 服务以获取通知数据。所需的行动取决于在配置存储桶通知时指定的 events

例如,如果存储桶通知配置包含 s3:ObjectCreated:Put 事件,您可以使用 mc cp 命令在存储桶中创建新的对象并触发通知。

mc cp ~/data/new-object.txt ALIAS/BUCKET