發佈事件至 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 支援在執行中的 minio server
程序上新增或更新 MQTT 端點,方法是使用 mc admin config set
命令和 notify_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 服務中的通知資料。所需動作取決於在設定儲存貯體通知時指定的 事件
。
例如,如果儲存貯體通知組態包含 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