文件

發布事件至 MQTT

MinIO 支援將 儲存桶通知 事件發布至 MQTT 伺服器/代理端點。

新增 MQTT 端點至 MinIO 部署

以下程序會新增一個新的 MQTT 服務端點,以支援 MinIO 部署中的儲存桶通知

先決條件

MQTT 3.1 或 3.1.1 伺服器/代理

此程序假設存在 MinIO 部署具有連線能力的現有 MQTT 3.1 或 3.1.1 伺服器/代理。有關 MQTT 相容伺服器/代理的列表,請參閱 mqtt.org 軟體列表

如果 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 主題。

請參閱 用於 Bucket 通知的 MQTT 服務 以取得每個環境變數的完整說明文件。

MinIO 支援在執行中的 minio server 程序上新增或更新 MQTT 端點,方法是使用 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 Bucket 通知組態設定 以取得每個設定的完整說明文件。

2) 重新啟動 MinIO 部署

您必須重新啟動 MinIO 部署才能套用組態變更。使用 mc admin service restart 命令來重新啟動部署。

mc admin service restart ALIAS

ALIAS 替換為要重新啟動之部署的 別名

minio server 程序會在啟動時針對每個設定的 MQTT 目標列印一行,類似於以下內容:

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

當使用相關聯的 MQTT 部署作為目標來設定 bucket 通知時,您必須指定 ARN 資源。

識別您的 bucket 通知的 ARN

您在先前建立端點時定義了 <IDENTIFIER>,以指派給您的 bucket 通知的目標 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 端點作為目標設定 Bucket 通知

使用 mc event add 命令新增具有已設定 MQTT 服務作為目標的新 bucket 通知事件。

mc event add ALIAS/BUCKET arn:minio:sqs::primary:mqtt \
  --event EVENTS
  • ALIAS 替換為 MinIO 部署的 別名

  • BUCKET 替換為要設定事件的 bucket 名稱。

  • EVENTS 替換為 MinIO 觸發通知的 事件 的逗號分隔清單。

使用 mc event ls 來檢視指定通知目標的所有已設定 bucket 事件

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

4) 驗證已設定的事件

對您設定新事件的 bucket 執行動作,並檢查 MQTT 服務的通知資料。所需的動作取決於在設定 bucket 通知時指定的 事件

例如,如果 bucket 通知組態包含 s3:ObjectCreated:Put 事件,您可以使用 mc cp 命令在 bucket 中建立新物件並觸發通知。

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

更新 MinIO 部署中的 MQTT 端點

以下程序會更新現有的 MQTT 服務端點,以支援 MinIO 部署中的 bucket 通知

先決條件

MQTT 3.1 或 3.1.1 伺服器/訊息代理端點

此程序假設存在 MinIO 部署具有連線能力的現有 MQTT 3.1 或 3.1.1 伺服器/代理。有關 MQTT 相容伺服器/代理的列表,請參閱 mqtt.org 軟體列表

如果 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 服務是否有通知資料。所需的操作取決於在設定儲存桶通知時指定的 事件

例如,如果 bucket 通知組態包含 s3:ObjectCreated:Put 事件,您可以使用 mc cp 命令在 bucket 中建立新物件並觸發通知。

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