将事件发布到 MQTT

MinIO 支持将 存储桶通知 事件发布到 MQTT server/broker 端点。

向 MinIO 部署添加 MQTT 端点

以下过程会添加一个新的 MQTT 服务端点，以在 MinIO 部署中支持 存储桶通知。

前提条件

MQTT 3.1 或 3.1.1 服务器/代理

此过程假定已存在一个 MQTT 3.1 或 3.1.1 server/broker，且 MinIO 部署能够连接到它。有关兼容 MQTT 的 server/broker 列表，请参见 mqtt.org software listing。

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

MinIO mc 命令行工具

此过程中的某些操作需要使用 mc 命令行工具。 安装说明请参见 mc 快速入门。

1) 将 MQTT 端点添加到 MinIO

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

• Environment Variables
• Configuration Settings

   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>"

   export MINIO_NOTIFY_MQTT_ENABLE_<IDENTIFIER>="on"
   export MINIO_NOTIFY_MQTT_BROKER_<IDENTIFIER>="ENDPOINT"
   export MINIO_NOTIFY_MQTT_TOPIC_<IDENTIFIER>="TOPIC"
   export MINIO_NOTIFY_MQTT_USERNAME_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_MQTT_PASSWORD_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_MQTT_QOS_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_MQTT_KEEP_ALIVE_INTERVAL_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_MQTT_RECONNECT_INTERVAL_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_MQTT_QUEUE_DIR_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_MQTT_QUEUE_LIMIT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_MQTT_COMMENT_<IDENTIFIER>="<string>"

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>"

1) 重启 MinIO 部署

你必须重启 MinIO 部署以应用配置更改。 使用 mc admin service restart 命令重启该部署。

mc admin service restart ALIAS

将 ALIAS 替换为要重启的部署的 别名。

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

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

将关联的 MQTT 部署配置为目标时，你必须在配置存储桶通知时指定 ARN 资源。

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 server/broker，且 MinIO 部署能够连接到它。有关兼容 MQTT 的 server/broker 列表，请参见 mqtt.org software listing。

如果 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_mqtt 键是 MQTT 通知设置 的顶层配置键。 broker 键为给定的 notify_mqtt 键指定 MQTT server/broker 端点。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 server/broker 端点的最少必需项：

• broker
• topic
• username 如果 MQTT server/broker 强制要求身份验证/授权，则必需
• password 如果 MQTT server/broker 强制要求身份验证/授权，则必需

所有其他配置设置均为可选。有关 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 服务中的通知数据。所需操作取决于配置存储桶通知时指定了哪些 事件。

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

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