欢迎来到即将发布的 MinIO 文档版本! 此页面上的内容正在积极开发中 可能随时更改。 如果找不到您要找的内容,请查看我们的 历史文档。 感谢您的耐心等待。 我们期待您贡献自己强大的力量,帮助更多的中国技术开发者![翻译]

将事件发布到 MQTT

MinIO 支持发布 bucket notification 事件 MQTT 服务器/代理端点。

将 MQTT 端点添加到 MinIO 部署

以下过程添加了一个新的 MQTT 服务端点以支持 bucket notifications 在一个 MinIO 部署。

Important

这个程序 requires 全部重启 minio server 流程 同时与部署相关联。 通常有一个简短的 API 操作中断或可能失败的时间段。

使用带有内置重试逻辑的 S3 兼容 SDK 的应用程序 or 实现手动重试逻辑通常不会遇到明显的中断 服务。 对于不能使用重试逻辑的应用,考虑调度 一个维护期,以尽量减少在执行时服务的中断这个程序。

先决条件

MQTT 3.1 或 3.1.1 服务器/代理

此过程假定现有 MQTT 3.1 或 3.1.1 服务器/代理 MinIO 部署具有连接性。 见 mqtt.org software listing 对于一个列表 MQTT 兼容的服务器/代理。

如果 MQTT 服务需要身份验证,您 must 提供适当的 在配置过程中授予 MinIO 访问权限的用户名和密码 到服务。

MinIO mc 命令行工具

此过程使用 mc 用于某些操作的命令行工具。 见 mc Quickstart 安装说明。

1) 将 MQTT 端点添加到 MinIO

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

MinIO 支持指定 MQTT 服务端点和关联 配置设置使用 environment variables. The minio server 进程在其上应用指定的设置 下次启动。

以下示例代码设置了 all 环境变量 与配置 MQTT 服务端点相关。 最低 required 变量是:

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 服务端点。 对所有使用相同的 <IDENTIFIER> 值 与新 MQTT 服务端点相关的环境变量。 以下示例假定标识符为 “PRIMARY”。

    如果指定的``<IDENTIFIER>`` 匹配现有的 MQTT 服务 MinIO 部署上的端点,新设置 override 该端点的任何现有设置。 用 mc admin config get notify_mqtt 查看 MinIO 部署上当前配置的 MQTT 端点。

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

    tcp://hostname:port

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

MQTT Service for Bucket Notifications 完整的文档 在每个环境变量上。

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

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

  • broker

  • topic

  • username Required if the MQTT server/broker enforces authentication/authorization

  • password Required if the MQTT server/broker enforces authentication/authorization

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” 与现有的 MQTT 服务匹配 MinIO 部署上的端点,新设置 override 该端点的任何现有设置。 用 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 命令重新启动部署。

Important

MinIO 重启 all minio server 相关流程 同时部署。 应用程序可能会经历短暂的 重启过程中的停机时间。

考虑在维护期间安排重启以最小化服务中断。

mc admin service restart ALIAS

将 “ALIAS” 替换为 alias 部署重新开始。

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

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

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

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

使用 mc event add 添加新存储通知的命令 以配置的 MQTT 服务为目标的事件:

mc event add ALIAS/BUCKET arn:minio:sqs::primary:mqtt \
  --event EVENTS
  • 将 “ALIAS” 替换为 alias 一个 MinIO 部署。

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

  • 用逗号分隔的列表替换 “EVENTS” events MinIO 为其触发通知。

mc event list 查看所有配置的存储事件 给定的通知目标:

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

4) 验证配置的事件

对配置了新事件的存储执行操作,然后 检查 MQTT 服务以获取通知数据。 需要采取的行动 取决于哪个 events 被指定 配置存储通知时。

检查 MQTT 服务以获取通知数据。 需要采取的行动 例如,如果存储通知配置包括 s3:ObjectCreated:Put 事件,您可以使用 mc cp 命令在存储中创建一个新对象并触发 通知。

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

在 MinIO 部署中更新 MQTT 端点

以下过程更新现有的 MQTT 服务端点以支持 bucket notifications 在一个 MinIO 部署。

Important

这个程序 requires 全部重启 minio server 流程 同时与部署相关联。 通常有一个简短的 API 操作中断或可能失败的时间段。

使用带有内置重试逻辑的 S3 兼容 SDK 的应用程序 or 实现手动重试逻辑通常不会遇到明显的中断 服务。 对于不能使用重试逻辑的应用,考虑调度 一个维护期,以尽量减少在执行时服务的中断这个程序。

先决条件

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

此过程假定现有 MQTT 3.1 或 3.1.1 服务器/代理 MinIO 部署具有连接性。 见 mqtt.org software listing 对于一个列表 MQTT 兼容的服务器/代理。

如果 MQTT 服务需要身份验证,您 must 提供适当的 在配置过程中授予 MinIO 访问权限的用户名和密码 到服务。

MinIO mc 命令行工具

此过程使用 mc 用于某些操作的命令行工具。 见 mc Quickstart 安装说明。

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

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

mc admin config get ALIAS/ notify_mqtt

将 “ALIAS” 替换为 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=""

The notify_mqtt key 是一个顶级配置键 用于存储桶通知的 MQTT 服务. The broker key 指定 MQTT 服务器/代理端点 对于给定的 notify_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>"

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

  • broker

  • topic

  • username Required if the MQTT server/broker enforces authentication/authorization

  • password Required if the MQTT server/broker enforces authentication/authorization

所有其他配置设置都是 optional。 看 用于存储桶通知的 MQTT 服务 获取完整的 MQTT 列表 配置设置。

3) 重启 MinIO 部署

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

Important

MinIO 重启 all minio server 相关流程 同时部署。 应用程序可能会经历短暂的 重启过程中的停机时间。

考虑在维护期间安排重启以最小化服务中断。

mc admin service restart ALIAS

将 “ALIAS” 替换为 alias 部署重新开始。 The 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