文档

将事件发布到 Webhook

MinIO 支持将 存储桶通知 事件发布到 Webhook 服务端点。

向 MinIO 部署添加 Webhook 端点

以下过程将为在 MinIO 部署中支持 存储桶通知 添加一个新的 Webhook 服务端点。

先决条件

MinIO mc 命令行工具

此过程使用 mc 命令行工具来执行某些操作。有关安装说明,请参阅 mc 快速入门

1) 向 MinIO 添加 Webhook 端点

您可以使用环境变量设置运行时配置设置来配置新的 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 支持使用 minio server 命令和 mc admin config set 命令在运行的 minio server 进程上添加或更新 Webhook 端点,并使用 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

您之前在创建端点时定义了要分配给存储桶通知目标 ARN 的 <IDENTIFIER>。以下步骤将返回在部署中配置的 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