發布事件到 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` 命令列工具

此程序會使用 mc 命令列工具來執行某些動作。有關安裝說明，請參閱mc 快速入門。

1) 將 MQTT 端點新增到 MinIO

您可以使用環境變數或設定執行階段配置設定來配置新的 MQTT 服務端點。

環境變數

MinIO 支援使用環境變數指定 MQTT 服務端點和相關配置設定。minio server 程序會在下次啟動時套用指定的設定。

以下範例程式碼會設定與配置 MQTT 服務端點相關的所有環境變數。必要的最小變數為

MINIO_NOTIFY_MQTT_ENABLE
MINIO_NOTIFY_MQTT_BROKER
MINIO_NOTIFY_MQTT_TOPIC
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 伺服器/代理端點所需的最低要求

broker
topic
username 如果 MQTT 伺服器/代理強制執行驗證/授權，則為必要項目
password 如果 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 中的值

安裝 jq
複製並執行下列命令，將 ALIAS 替換為部署的別名。
```
mc admin info --json ALIAS | jq  .info.sqsARN
```
這會傳回要用於通知的 ARN，例如 arn:minio:sqs::primary:mqtt

1) 使用 MQTT 端點作為目標組態儲存貯體通知

使用 mc event add 命令新增以已組態 MQTT 服務為目標的新儲存貯體通知事件

mc event add ALIAS/BUCKET arn:minio:sqs::primary:mqtt \
  --event EVENTS

將 ALIAS 替換為 MinIO 部署的別名。
將 BUCKET 替換為要組態事件的儲存貯體名稱。
將 EVENTS 替換為以逗號分隔的事件清單，MinIO 會針對這些事件觸發通知。

使用 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 伺服器/代理端點

此程序假設存在 MinIO 部署可連線到的現有 MQTT 3.1 或 3.1.1 伺服器/代理。有關 MQTT 相容伺服器/代理的清單，請參閱mqtt.org 軟體清單。

如果 MQTT 服務需要驗證，您必須在配置過程中提供適當的使用者名稱和密碼，以授與 MinIO 存取該服務的權限。

MinIO `mc` 命令列工具

此程序會使用 mc 命令列工具來執行某些動作。有關安裝說明，請參閱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=""

請注意您要為下一步更新的 MQTT 服務端點的識別符。

2) 更新 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 伺服器/代理端點所需的最低限度設定。

broker
topic
username 如果 MQTT 伺服器/代理強制執行驗證/授權，則為必要項目
password 如果 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

發布事件到 MQTT

將 MQTT 端點新增到 MinIO 部署

先決條件

MQTT 3.1 或 3.1.1 伺服器/代理

MinIO mc 命令列工具

1) 將 MQTT 端點新增到 MinIO

2) 重新啟動 MinIO 部署

1) 使用 MQTT 端點作為目標組態儲存貯體通知

4) 驗證已組態的事件

更新 MinIO 部署中的 MQTT 端點

必要條件

MQTT 3.1 或 3.1.1 伺服器/代理端點

MinIO mc 命令列工具

1) 列出部署中已組態的 MQTT 端點

2) 更新 MQTT 端點

3) 重新啟動 MinIO 部署

3) 驗證變更

MinIO `mc` 命令列工具

MinIO `mc` 命令列工具