文件

Webhook 服務通知設定

本頁說明將 Webhook 服務設定為 Bucket 通知 目標的設定。請參閱 發佈事件至 Webhook,以取得有關使用這些設定的教學。

您可以透過定義以下方式建立或修改設定

  • 在啟動或重新啟動 MinIO 伺服器之前,在主機系統上定義一個環境變數。請參閱您作業系統的文件,了解如何定義環境變數。

  • 使用 mc admin config set 使用組態設定

  • 使用 MinIO 主控台管理員 > 設定 頁面使用組態設定

如果您同時定義環境變數和類似的組態設定,MinIO 會使用環境變數的值。

某些設定只有環境變數或組態設定,但沒有兩者。

重要事項

每個組態設定都控制著 MinIO 的基本行為和功能。MinIO 強烈建議在將組態變更應用於生產環境之前,先在較低的環境 (例如 DEV 或 QA) 中測試。

多個 Webhook 服務目標

您可以透過在頂層鍵上附加一個唯一識別碼 _ID,為每個相關的 Webhook 設定組合指定多個 Webhook 服務端點。例如,以下命令將兩個不同的 Webhook 服務端點分別設定為 PRIMARYSECONDARY

set MINIO_NOTIFY_WEBHOOK_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_WEBHOOK_ENDPOINT_PRIMARY="https://webhook1.example.net"

set MINIO_NOTIFY_WEBHOOK_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_WEBHOOK_ENDPOINT_SECONDARY="https://webhook1.example.net"
mc admin config set notify_webhook:primary \
   endpoint="https://webhook1.example.net"
   [ARGUMENT=VALUE ...]

mc admin config set notify_webhook:secondary \
   endpoint="https://webhook2.example.net
   [ARGUMENT=VALUE ...]

設定

啟用

必要

MINIO_NOTIFY_WEBHOOK_ENABLE

指定 on 以啟用發佈儲存桶通知至 Webhook 服務端點。

預設值為 off

notify_webhook

用於定義 Webhook 服務端點的頂層組態鍵,以便與 MinIO 儲存桶通知 搭配使用。

使用 mc admin config set 來設定或更新 Webhook 服務端點。endpoint 引數對於每個目標都是必要的。指定其他可選引數,以空白(" ")分隔的列表形式。

mc admin config set notify_webhook \
  endpoint="https://webhook.example.net"
  [ARGUMENT="VALUE"] ... \

端點

必要

MINIO_NOTIFY_WEBHOOK_ENDPOINT
notify_webhook endpoint

指定 webhook 服務的 URL。

變更於版本 RELEASE.2023-05-27T05-56-19Z:MinIO 會在新增目標之前檢查指定的 URL 的健康狀態(是否可解析且可連線)。如果現有的目標離線,MinIO 不再阻止新增新的通知目標。

驗證權杖

必要

MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN

端點的適當類型驗證權杖。對於不需要驗證的端點,則省略此項。

為了允許各種權杖類型,MinIO 會使用完全依照指定的值來建立請求驗證標頭。根據端點的不同,您可能需要包含其他資訊。

例如,對於 Bearer 權杖,請在前面加上 Bearer

set MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_myendpoint="Bearer 1a2b3c4f5e"

請根據端點需求修改值。自訂驗證格式可能如下所示

set MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_xyz="ServiceXYZ 1a2b3c4f5e"

如需更多詳細資訊,請參閱所需服務的文件。

notify_webhook auth_token

端點的適當類型驗證權杖。對於不需要驗證的端點,則省略此項。

為了允許各種權杖類型,MinIO 會使用完全依照指定的值來建立請求驗證標頭。根據端點的不同,您可能需要包含其他資訊。

例如,對於 Bearer 權杖,請在前面加上 Bearer

   mc admin config set myminio notify_webhook   \
   endpoint="https://webhook-1.example.net"  \
      auth_token="Bearer 1a2b3c4f5e"

請根據端點需求修改值。自訂驗證格式可能如下所示

   mc admin config set myminio notify_webhook   \
      endpoint="https://webhook-1.example.net"  \
      auth_token="ServiceXYZ 1a2b3c4f5e"

如需更多詳細資訊,請參閱所需服務的文件。

變更於版本 RELEASE.2023-06-23T20-26-00Z。

當作為 mc admin config get 的一部分傳回時,MinIO 會編輯此值。

佇列目錄

可選

MINIO_NOTIFY_WEBHOOK_QUEUE_DIR
notify_webhook queue_dir

指定目錄路徑以啟用 MinIO 的永久事件儲存區,用於儲存未傳遞的訊息,例如 /opt/minio/events

當 webhook 服務離線時,MinIO 會將未傳遞的事件儲存在指定的儲存區中,並在連線恢復時重新播放儲存的事件。

佇列限制

可選

MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT
notify_webhook queue_limit

指定未傳遞訊息的最大限制。預設值為 100000

用戶端憑證

可選

MINIO_NOTIFY_WEBHOOK_CLIENT_CERT
notify_webhook client_cert

指定用戶端憑證的路徑,以用於對 webhook 服務執行 mTLS 驗證。

用戶端金鑰

可選

MINIO_NOTIFY_WEBHOOK_CLIENT_KEY
notify_webhook client_key

指定用戶端私密金鑰的路徑,以用於對 webhook 服務執行 mTLS 驗證。

MaxRetry

可選

MINIO_NOTIFY_WEBHOOK_MAX_RETRY
notify_webhook max_retry

重試事件傳送的最大嘗試次數。預設情況下,最大重試次數設定為 0

RetryInterval

可選

MINIO_NOTIFY_WEBHOOK_RETRY_INTERVAL
notify_webhook retry_interval

重試嘗試之間的等待時間長度。預設值為 3s

註解

可選

MINIO_NOTIFY_WEBHOOK_COMMENT
notify_webhook comment

指定與 Webhook 組態相關聯的註解。