将事件发布到 MQTT

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

在 MinIO 部署中添加 MQTT 端点

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

先决条件

MQTT 3.1 或 3.1.1 服务器/代理

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

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

MinIO `mc` 命令行工具

此过程使用mc 命令行工具执行某些操作。请参阅 mc 快速入门，了解安装说明。

1) 将 MQTT 端点添加到 MinIO

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

环境变量

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

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

MINIO_NOTIFY_MQTT_ENABLE
MINIO_NOTIFY_MQTT_BROKER
MINIO_NOTIFY_MQTT_TOPIC
MINIO_NOTIFY_MQTT_USERNAME *如果 MQTT 服务器/代理强制执行身份验证/授权，则为必需*
MINIO_NOTIFY_MQTT_PASSWORD *如果 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服务。

配置设置

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

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

代理
主题
用户名 如果MQTT服务器/代理强制执行身份验证/授权，则为必需
密码 如果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存储桶通知配置设置。

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输出

复制并运行以下命令，将ALIAS替换为部署的别名。
```
mc admin info --json ALIAS
```
在JSON输出中，查找键info.sqsARN。

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

例如，arn:minio:sqs::primary:mqtt。

使用jq解析JSON以获取值

安装jq
复制并运行以下命令，将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 服务需要身份验证，则*必须*在配置过程中提供相应的用户名和密码，以授予 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 服务器/代理端点。 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 服务器/代理端点所需的 *最低* 要求。

代理
主题
用户名 如果MQTT服务器/代理强制执行身份验证/授权，则为必需
密码 如果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

将事件发布到 MQTT

在 MinIO 部署中添加 MQTT 端点

先决条件

MQTT 3.1 或 3.1.1 服务器/代理

MinIO mc 命令行工具

1) 将 MQTT 端点添加到 MinIO

2) 重新启动MinIO部署

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

4) 验证配置的事件

更新MinIO部署中的MQTT端点

先决条件

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

MinIO mc命令行工具

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

2) 更新 MQTT 端点

3) 重启 MinIO 部署

3) 验证更改

MinIO `mc` 命令行工具

MinIO `mc`命令行工具