發佈事件到 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
命令列工具
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 相容伺服器/代理的清單,請參閱 mqtt.org 軟體清單。
如果 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=""
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>"
您必須重新啟動 MinIO 部署,才能套用組態變更。使用 mc admin service restart
命令來重新啟動部署。
mc admin service restart ALIAS
將 ALIAS
取代為要重新啟動的部署的別名。
minio server
處理程序會在啟動時為每個已設定的 MQTT 目標列印類似以下的行
SQS ARNs: arn:minio:sqs::primary:mqtt
例如,如果儲存貯體通知組態包含 s3:ObjectCreated:Put
事件,您可以使用 mc cp
命令,在儲存貯體中建立新物件並觸發通知。
mc cp ~/data/new-object.txt ALIAS/BUCKET