文件

發佈事件至 MQTT

MinIO 支援將 儲存區通知 事件發佈到 MQTT 伺服器/代理端點。

將 MQTT 端點新增至 MinIO 部署

以下程序新增一個新的 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 服務端點相關的所有環境變數。最需要以下變數:

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 伺服器/代理端點的最低要求:

  • 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 儲存貯體通知組態設定以取得每個設定的完整文件。

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

先前在建立端點時,您已定義 <IDENTIFIER> 來指派給您的儲存貯體通知的目標 ARN。以下步驟會傳回部署上設定的 ARN。藉由尋找您指定的 <IDENTIFIER> 來識別先前建立的 ARN。

檢閱 JSON 輸出

  1. 複製並執行以下命令,將 ALIAS 替換為部署的 別名

    mc admin info --json ALIAS
    
  2. 在 JSON 輸出中,尋找金鑰 info.sqsARN

    您需要的 ARN 是符合您指定之 <IDENTIFIER> 的金鑰的值。

    例如,arn:minio:sqs::primary:mqtt

使用 jq 來剖析 JSON 的值

  1. 安裝 jq

  2. 複製並執行以下命令,將 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 3.1 或 3.1.1 伺服器/代理,MinIO 部署已連接到該伺服器/代理。請參閱 mqtt.org 軟體清單以取得與 MQTT 相容的伺服器/代理清單。

如果 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 伺服器/代理端點所需的最低設定

  • broker

  • topic

  • username 如果 MQTT 伺服器/代理強制執行驗證/授權,則為必要

  • password 如果 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