發布事件至 MQTT
MinIO 支援將 儲存桶通知 事件發布至 MQTT 伺服器/代理端點。
將 MQTT 端點新增至 MinIO 部署
以下程序會新增一個新的 MQTT 服務端點,以支援 MinIO 部署中的儲存桶通知。
先決條件
MQTT 3.1 或 3.1.1 伺服器/代理
此程序假設存在 MinIO 部署具有連線能力的 MQTT 3.1 或 3.1.1 伺服器/代理。請參閱 mqtt.org 軟體清單,以取得與 MQTT 相容的伺服器/代理清單。
如果 MQTT 服務需要驗證,您必須在組態過程中提供適當的使用者名稱和密碼,以授與 MinIO 存取服務的權限。
MinIO mc
命令列工具
1) 將 MQTT 端點新增至 MinIO
您可以使用環境變數或設定執行階段組態設定來設定新的 MQTT 服務端點。
MinIO 支援使用環境變數來指定 MQTT 服務端點和相關的配置設定。minio server
程序會在下次啟動時套用指定的設定。
以下範例程式碼設定了所有與配置 MQTT 服務端點相關的環境變數。 最少必要的變數是
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 伺服器/代理程式端點所需的最少設定
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 輸出
複製並執行以下命令,將
ALIAS
替換為部署的 別名。mc admin info --json ALIAS
在 JSON 輸出中,尋找索引鍵
info.sqsARN
。您需要的 ARN 是符合您指定的
<IDENTIFIER>
的索引鍵值。例如,
arn:minio:sqs::primary:mqtt
。
使用 jq 來剖析 JSON 的值
1) 使用 MQTT 端點作為目標配置儲存桶通知
使用 mc event add
命令,以配置的 MQTT 服務作為目標,新增新的儲存桶通知事件
mc event add ALIAS/BUCKET arn:minio:sqs::primary:mqtt \
--event EVENTS
使用 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 伺服器/代理程式端點
此程序假設存在 MinIO 部署具有連線能力的 MQTT 3.1 或 3.1.1 伺服器/代理。請參閱 mqtt.org 軟體清單,以取得與 MQTT 相容的伺服器/代理清單。
如果 MQTT 服務需要驗證,您必須在組態過程中提供適當的使用者名稱和密碼,以授與 MinIO 存取服務的權限。
MinIO 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 通知設定。
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 服務是否有通知資料。所需的操作取決於在設定儲存貯體通知時指定的 事件
。
例如,如果儲存桶通知配置包含 s3:ObjectCreated:Put
事件,您可以使用 mc cp
命令,在儲存桶中建立新物件並觸發通知。
mc cp ~/data/new-object.txt ALIAS/BUCKET