文件

發布事件至 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