發佈事件至 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
命令列工具
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
您先前在建立端點時定義了要指派給儲存貯體通知目標 ARN 的 <IDENTIFIER>
。以下步驟會傳回部署上已設定的 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 伺服器/訊息代理器端點
此程序假設有一個現有的 MQTT 3.1 或 3.1.1 伺服器/代理,MinIO 部署已與其連線。請參閱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 服務以取得通知資料。所需的操作取決於配置儲存桶通知時指定的 events
。
例如,如果儲存貯體通知設定包含 s3:ObjectCreated:Put
事件,您可以使用 mc cp
命令在儲存貯體中建立新物件並觸發通知。
mc cp ~/data/new-object.txt ALIAS/BUCKET