發佈事件至 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 服務端點的唯一描述性字串。將相同的<IDENTIFIER>
值用於與新 MQTT 服務端點相關的所有環境變數。下列範例假設識別碼為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 伺服器/代理端點
此程序假設現有的 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