將事件發佈至 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 支援使用 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 輸出
複製並執行下列命令,將
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 服務中的通知資料。所需的動作取決於在設定儲存桶通知時指定的 events
。
例如,如果儲存桶通知組態包含 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