文件

發佈事件到 Webhook

MinIO 支援將 儲存桶通知 事件發佈到 Webhook 服務端點。

將 Webhook 端點新增到 MinIO 部署

以下程序會新增一個新的 Webhook 服務端點,以支援 MinIO 部署中的儲存桶通知

先決條件

MinIO mc 命令列工具

此程序會使用 mc 命令列工具執行某些動作。請參閱 mc 快速入門 以取得安裝指示。

1) 將 Webhook 端點新增到 MinIO

您可以使用環境變數設定執行階段組態設定來設定新的 Webhook 服務端點。

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

以下範例程式碼設定與設定 Webhook 服務端點相關的所有環境變數。最小必要變數是 MINIO_NOTIFY_WEBHOOK_ENABLEMINIO_NOTIFY_WEBHOOK_ENDPOINT

set MINIO_NOTIFY_WEBHOOK_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_WEBHOOK_ENDPOINT_<IDENTIFIER>="ENDPOINT"
set MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_WEBHOOK_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_WEBHOOK_CLIENT_CERT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_WEBHOOK_CLIENT_KEY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_WEBHOOK_COMMENT_<IDENTIFIER>="<string>"
  • <IDENTIFIER> 取代為 Webhook 服務端點的唯一描述性字串。對於與新目標服務端點相關的所有環境變數,使用相同的 <IDENTIFIER> 值。以下範例假設識別碼為 PRIMARY

    如果指定的 <IDENTIFIER> 與 MinIO 部署上現有的 Webhook 服務端點相符,則新的設定會覆寫該端點的任何現有設定。請使用 mc admin config get notify_webhook 來檢視 MinIO 部署上目前設定的 Webhook 端點。

  • <ENDPOINT> 替換為 Webhook 服務端點的 URL。例如:

    https://webhook.example.com

請參閱 用於儲存桶通知的 Webhook 服務,以取得每個環境變數的完整文件。

MinIO 支援使用 mc admin config set 命令和 notify_webhook 組態鍵,在執行中的 minio server 程序上新增或更新 Webhook 端點。您必須重新啟動 minio server 程序,才能套用任何新的或更新的組態設定。

以下範例程式碼設定與設定 Webhook 服務端點相關的所有設定。最少必要的設定是 notify_webhook endpoint

mc admin config set ALIAS/ notify_webhook:IDENTIFIER \
   endpoint="<ENDPOINT>" \
   auth_token="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   client_cert="<string>" \
   client_key="<string>" \
   comment="<string>"
  • IDENTIFIER 替換為 Webhook 服務端點的唯一描述性字串。此程序中的以下範例假設識別碼為 PRIMARY

    如果指定的 IDENTIFIER 與 MinIO 部署上現有的 Webhook 服務端點相符,則新的設定會覆寫該端點的任何現有設定。請使用 mc admin config get notify_webhook 來檢視 MinIO 部署上目前設定的 Webhook 端點。

  • ENDPOINT 替換為 Webhook 服務端點的 URL。例如:

    https://webhook.example.com

請參閱 Webhook 儲存桶通知組態設定,以取得每個設定的完整文件。

2) 重新啟動 MinIO 部署

您必須重新啟動 MinIO 部署,才能套用組態變更。使用 mc admin service restart 命令來重新啟動部署。

mc admin service restart ALIAS

ALIAS 替換為要重新啟動之部署的 別名

minio server 程序會在啟動時針對每個已設定的 Webhook 目標印出一行類似以下的內容:

SQS ARNs: arn:minio:sqs::primary:webhook

當設定以關聯的 Webhook 部署為目標的儲存桶通知時,您必須指定 ARN 資源。

識別儲存桶通知的 ARN

先前建立端點時,您定義了 <IDENTIFIER> 以指派給儲存桶通知的目標 ARN。下列步驟會傳回部署上設定的 ARN。藉由尋找您指定的 <IDENTIFIER>,找出先前建立的 ARN。

檢閱 JSON 輸出

  1. 複製並執行下列命令,將 ALIAS 替換為部署的 別名

    mc admin info --json ALIAS
    
  2. 在 JSON 輸出中,尋找金鑰 info.sqsARN

    您需要的 ARN 是符合您指定的 <IDENTIFIER> 的金鑰值。

    例如,arn:minio:sqs::primary:webhook

使用 jq 來剖析 JSON 的值

  1. 安裝 jq

  2. 複製並執行下列命令,將 ALIAS 替換為部署的 別名

    mc admin info --json ALIAS | jq  .info.sqsARN
    

    這會傳回用於通知的 ARN,例如 arn:minio:sqs::primary:webhook

3) 使用 Webhook 端點作為目標來設定儲存桶通知

使用 mc event add 命令,以已設定的 Webhook 服務作為目標來新增儲存桶通知事件。

mc event add ALIAS/BUCKET arn:minio:sqs::primary:webhook \
  --event EVENTS
  • ALIAS 替換為 MinIO 部署的 別名

  • BUCKET 替換為要在其中設定事件的儲存桶名稱。

  • EVENTS 替換為以逗號分隔的 事件 清單,MinIO 會針對這些事件觸發通知。

使用 mc event ls 來檢視指定通知目標的所有已設定儲存桶事件。

mc event ls ALIAS/BUCKET arn:minio:sqs::primary:webhook

4) 驗證已設定的事件

在您設定新事件的儲存桶上執行動作,並檢查 Webhook 服務是否有通知資料。所需的動作取決於設定儲存桶通知時指定的 events

例如,如果儲存桶通知組態包含 s3:ObjectCreated:Put 事件,則可以使用 mc cp 命令在儲存桶中建立新物件,並觸發通知。

mc cp ~/data/new-object.txt ALIAS/BUCKET

在 MinIO 部署中更新 Webhook 端點

以下程序會更新現有的 Webhook 服務端點,以支援 MinIO 部署中的 儲存桶通知

先決條件

MinIO mc 命令列工具

此程序會使用 mc 命令列工具執行某些動作。請參閱 mc 快速入門 以取得安裝指示。

1) 列出部署中設定的 Webhook 端點

使用 mc admin config get 命令來列出部署中目前設定的 Webhook 服務端點。

mc admin config get ALIAS/ notify_webhook

ALIAS 替換為 MinIO 部署的 別名

命令輸出類似如下:

notify_webhook:primary endpoint="https://webhook.example.com" auth_token="" queue_limit="0" queue_dir="" client_cert="" client_key=""
notify_webhook:secondary endpoint="https://webhook.example.com" auth_token="" queue_limit="0" queue_dir="" client_cert="" client_key=""

notify_webhook 金鑰是 Webhook 服務通知設定 的最上層組態金鑰。endpoint 金鑰指定給定 notify_webhook 金鑰的 Webhook 服務端點。notify_webhook:<IDENTIFIER> 後綴會描述該 Webhook 服務端點的唯一識別碼。

請注意您要更新的 Webhook 服務端點的識別碼,以便進行下一步。

2) 更新 Webhook 端點

使用 mc admin config set 指令來設定 Webhook 服務端點的新配置。

mc admin config set ALIAS/ notify_webhook:IDENTIFIER \
   endpoint="<ENDPOINT>" \
   auth_token="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   client_cert="<string>" \
   client_key="<string>" \
   comment="<string>"

notify_webhook endpoint 配置設定是 Webhook 服務端點所需的最低要求。所有其他配置設定都是選用的。請參閱 Webhook 服務通知設定 以取得完整的 Webhook 配置設定列表。

3) 重新啟動 MinIO 部署

您必須重新啟動 MinIO 部署,才能套用組態變更。使用 mc admin service restart 命令來重新啟動部署。

mc admin service restart ALIAS

ALIAS 替換為要重新啟動之部署的 別名

minio server 程序會在啟動時針對每個已設定的 Webhook 目標印出一行類似以下的內容:

SQS ARNs: arn:minio:sqs::primary:webhook

4) 驗證變更

在具有使用更新的 Webhook 服務端點的事件配置的儲存貯體上執行動作,並檢查 Webhook 服務的通知資料。所需的動作取決於配置儲存貯體通知時指定的 events

例如,如果儲存桶通知組態包含 s3:ObjectCreated:Put 事件,則可以使用 mc cp 命令在儲存桶中建立新物件,並觸發通知。

mc cp ~/data/new-object.txt ALIAS/BUCKET