文档

MQTT 通知设置

本页面记录了将 MQTT 服务配置为 存储桶通知 目标的相关设置。 有关如何使用这些设置的教程,请参阅 将事件发布到 MQTT

你可以通过以下方式建立或修改设置:

  • 在启动或重启 MinIO Server 之前,在宿主机系统上定义 环境变量。 如何定义环境变量,请参考所用操作系统的文档。

  • 使用 mc admin config set 定义 配置项

如果同时定义了环境变量和对应的配置项,MinIO 使用环境变量的值。

有些设置只有环境变量或配置项中的一种,而不是两者同时存在。

Important

每个配置项都会控制 MinIO 的基础行为和功能。 MinIO 强烈建议 先在 DEV 或 QA 等较低级别环境中测试配置变更,再应用到生产环境。

多个 MQTT 目标

你可以在顶层键后为每组相关 MQTT 设置追加一个唯一标识符 _ID,以指定多个 MQTT 服务端点。 例如,以下命令分别将两个不同的 MQTT 服务端点设置为 PRIMARYSECONDARY

export MINIO_NOTIFY_MQTT_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_MQTT_BROKER_PRIMARY="tcp://user:password@mqtt-endpoint.example.net:1883"

export MINIO_NOTIFY_MQTT_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_MQTT_BROKER_SECONDARY="tcp://user:password@mqtt-endpoint.example.net:1883"
mc admin config set notify_mqtt:primary \
   broker="tcp://endpoint:port" \
   topic="minio/bucket-name/events/" \
   username="username" \
   password="password" \
   [ARGUMENT="VALUE"] ... \

mc admin config set notify_mqtt:secondary \
   broker="tcp://endpoint:port" \
   topic="minio/bucket-name/events/" \
   username="username" \
   password="password" \
   [ARGUMENT="VALUE"] ... \

在这些设置中,MINIO_NOTIFY_MQTT_ENABLE_PRIMARY 表示该环境变量与 ID 为 PRIMARY 的 MQTT 服务端点关联。

设置

启用

必填

MINIO_NOTIFY_MQTT_ENABLE

指定 on 以启用将存储桶通知发布到 MQTT 端点。

默认为 off

notify_mqtt

用于定义 MQTT server/broker 端点的顶层配置键,可用于 MinIO 存储桶通知

使用 mc admin config set 设置或更新 MQTT server/broker 端点。 每个端点都*必须*包含以下参数:

  • broker

  • topic

  • username 如果 MQTT server/broker 不强制认证/授权,则为可选

  • password 如果 MQTT server/broker 不强制认证/授权,则为可选

其他可选参数请以空白字符(" ")分隔的列表形式指定。

mc admin config set notify_mqtt \
   broker="tcp://endpoint:port" \
   topic="minio/bucket-name/events/" \
   username="username" \
   password="password" \
   [ARGUMENT="VALUE"] ... \

Broker

必填

MINIO_NOTIFY_MQTT_BROKER
notify_mqtt broker

指定 MQTT server/broker 端点。 MinIO 支持通过 TCP、TLS 或 Websocket 连接到 server/broker URL。 例如:

  • tcp://mqtt.example.net:1883

  • tls://mqtt.example.net:1883

  • ws://mqtt.example.net:1883

Changed in version RELEASE.2023-05-27T05-56-19Z: 在添加目标之前,如果指定的 URL 可解析且可达, MinIO 会先检查其健康状态。 如果现有目标处于离线状态,MinIO 也不再阻止添加新的通知目标。

Topic

必填

MINIO_NOTIFY_MQTT_TOPIC
notify_mqtt topic

指定 MQTT topic 名称,用于关联 MinIO 发布到 MQTT 端点的事件。

Username

如果 MQTT server/broker 强制认证/授权,则必填

MINIO_NOTIFY_MQTT_USERNAME
notify_mqtt username

指定 MinIO 用于向 MQTT server/broker 进行身份认证的 MQTT 用户名。

Password

如果 MQTT server/broker 强制认证/授权,则必填

MINIO_NOTIFY_MQTT_PASSWORD
notify_mqtt password

指定 MinIO 用于向 MQTT server/broker 进行身份认证的 MQTT 用户名对应的密码。

Changed in version RELEASE.2023-06-23T20-26-00Z: 作为 mc admin config get 返回结果的一部分时,MinIO 会对该值进行脱敏处理。

服务质量(QoS)

可选

MINIO_NOTIFY_MQTT_QOS
notify_mqtt qos

指定已发布事件的 Quality of Service 优先级。

默认为 0

Keep Alive 间隔

可选

MINIO_NOTIFY_MQTT_KEEP_ALIVE_INTERVAL
notify_mqtt keep_alive_interval

指定 MQTT 连接的 keep-alive 间隔。MinIO 支持以下时间单位:

  • s - 秒,例如 “60s”

  • m - 分钟,例如 “60m”

  • h - 小时,例如 “24h”

  • d - 天,例如 “7d”

重连间隔

可选

MINIO_NOTIFY_MQTT_RECONNECT_INTERVAL
notify_mqtt reconnect_interval

指定 MQTT 连接的重连间隔。MinIO 支持以下时间单位:

  • s - 秒,例如 “60s”

  • m - 分钟,例如 “60m”

  • h - 小时,例如 “24h”

  • d - 天,例如 “7d”

队列目录

可选

MINIO_NOTIFY_MQTT_QUEUE_DIR
notify_mqtt queue_dir

指定目录路径以启用 MinIO 的持久化事件存储,用于保存未投递消息,例如 /opt/minio/events

当 MQTT server/broker 离线时,MinIO 会将未投递事件存储在指定位置;连接恢复后会重放这些已存储事件。

队列上限

可选

MINIO_NOTIFY_MQTT_QUEUE_LIMIT
notify_mqtt queue_limit

指定未投递消息的最大上限。 默认为 100000

注释

可选

MINIO_NOTIFY_MQTT_COMMENT
notify_mqtt comment

指定与 MQTT 配置关联的注释。