发布事件到 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 服务端点or通过设置运行时配置设置。

环境变量

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

以下示例代码设置全部环境变量与配置 MQTT 服务端点相关。最低必需variables are:

MINIO_NOTIFY_MQTT_ENABLE
MINIO_NOTIFY_MQTT_BROKER
MINIO_NOTIFY_MQTT_TOPIC
MINIO_NOTIFY_MQTT_USERNAME 如果 MQTT 服务器/代理强制要求身份验证/授权，则此项为必填项
MINIO_NOTIFY_MQTT_PASSWORD 如果 MQTT 服务器/代理强制要求身份验证/授权，则此项为必填项

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

替换<IDENTIFIER>使用唯一的描述性字符串作为 MQTT 服务端点。使用相同的<IDENTIFIER>所有与新 MQTT 服务端点相关的环境变量值。以下示例假设标识符为PRIMARY.

如果指定的<IDENTIFIER>匹配 MinIO 部署中的现有 MQTT 服务端点，新设置覆盖该端点的任何现有设置。使用mc admin config get notify_mqtt审查 MinIO 部署中当前配置的 MQTT 端点。
替换<ENDPOINT>使用 MQTT 服务端点的 URL。例如：

tcp://hostname:port
替换TOPIC与 MinIO 关联的 MQTT 主题事件发布到服务器/代理。

看MQTT 服务用于存储桶通知有关每个环境变量的完整文档。

配置设置

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

以下示例代码设置全部与配置 MQTT 服务端点相关的设置。以下配置项为最小值MQTT 服务器/代理端点所需：

broker
topic
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 存储桶通知配置设置有关每个设置的完整文档。

1) 重启 MinIO 部署

您必须重启 MinIO 部署以使配置更改生效。使用mc admin service restart重启部署的命令。

mc admin service restart ALIAS

替换ALIAS随着别名部署的重新启动。

Theminio serverprocess prints a line on startup for each configured MQTT target similar to the following:

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

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

识别您的存储桶通知的ARN

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

审查 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服务以获取通知数据。所需操作取决于您配置的events在配置存储桶通知时已指定。

例如，如果存储桶通知配置包含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=""

Thenotify_mqttkey 是用于配置MQTT 通知设置. Thebrokerkey 指定给定设备的 MQTT 服务器/代理端点notify_mqttkey. Thenotify_mqtt:<IDENTIFIER>suffix 描述了该 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 服务器/代理端点的必需配置：

broker
topic
username 如果 MQTT 服务器/代理强制要求身份验证/授权，则此项为必填项
password 如果 MQTT 服务器/代理强制要求身份验证/授权，则此项为必填项

所有其他配置设置都是可选的. 查看MQTT 通知设置有关 MQTT 配置设置的完整列表。

3) 重启 MinIO 部署

您必须重启 MinIO 部署以使配置更改生效。使用mc admin service restart重启部署的命令。

mc admin service restart ALIAS

替换ALIAS随着别名部署的重新启动。

Theminio serverprocess prints a line on startup for each configured MQTT target similar to the following:

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 服务器/代理

MinIOmc命令行工具

1) 将 MQTT 端点添加到 MinIO

1) 重启 MinIO 部署

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

4) 验证已配置的事件

更新 MinIO 部署中的 MQTT 端点

前提条件

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

MinIOmc命令行工具

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

2) 更新 MQTT 端点

3) 重启 MinIO 部署

3) 验证更改

MinIO`mc`命令行工具

MinIO`mc`命令行工具