發佈事件至 Webhook
MinIO 支援將儲存桶通知事件發佈至Webhook服務端點。
將 Webhook 端點新增至 MinIO 部署
以下程序新增一個新的 Webhook 服務端點,以支援 MinIO 部署中的儲存桶通知。
先決條件
MinIO mc
命令列工具
1) 將 Webhook 端點新增至 MinIO
您可以使用環境變數或設定執行階段組態設定來設定新的 Webhook 服務端點。
MinIO 支援使用環境變數來指定 Webhook 服務端點和相關的組態設定。minio server
程序會在下次啟動時套用指定的設定。
以下範例程式碼設定所有與設定 Webhook 服務端點相關的環境變數。最低必要的變數是MINIO_NOTIFY_WEBHOOK_ENABLE
和MINIO_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 支援在執行中的 minio server
程序上新增或更新 Webhook 端點,方法是使用 mc admin config set
命令和 notify_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 輸出
複製並執行以下命令,並將
ALIAS
取代為部署的 別名。mc admin info --json ALIAS
在 JSON 輸出中,尋找鍵
info.sqsARN
。您需要的 ARN 是符合您指定的
<IDENTIFIER>
的該鍵值。例如,
arn:minio:sqs::primary:webhook
。
使用 jq 來剖析 JSON 以取得值
3) 使用 Webhook 端點做為目標來設定儲存桶通知
使用 mc event add
命令來新增具有設定的 Webhook 服務做為目標的新儲存桶通知事件
mc event add ALIAS/BUCKET arn:minio:sqs::primary:webhook \
--event EVENTS
使用 mc event ls
來檢視指定通知目標的所有已設定儲存桶事件
mc event ls ALIAS/BUCKET arn:minio:sqs::primary:webhook
4) 驗證已設定的事件
針對您設定新事件的儲存桶執行動作,並檢查 Webhook 服務的通知資料。所需的動作取決於設定儲存桶通知時指定的 事件
。
例如,如果儲存桶通知組態包含 s3:ObjectCreated:Put
事件,您可以使用 mc cp
命令在儲存桶中建立新物件並觸發通知。
mc cp ~/data/new-object.txt ALIAS/BUCKET
更新 MinIO 部署中的 Webhook 端點
以下程序會更新現有的 Webhook 服務端點,以支援 MinIO 部署中的儲存桶通知。
必要條件
MinIO 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