将事件发布至Webhook

MinIO 支持将 bucket notification 事件发布到一个 Webhook 服务端点。

将 Webhook 端点添加到 MinIO 部署

以下步骤为MinIO部署添加一个新的Webhook服务端点，以支持 bucket notifications 。

先决条件

MinIO `mc` 命令行工具

此过程使用 mc 命令行工具执行某些操作。请参阅 mc 的快速入门以获取安装说明。

1) 将 Webhook 端点添加到 MinIO

您可以使用任一环境配置新的 Webhook 服务端点变量或通过设置运行时配置设置。

Environment Variables

MinIO支持指定Webhook服务端点和关联配置设置使用环境变量. 当您设置环境变量后，minio server 进程将在下一次启动时应用这些设置。

以下是设置与配置Webhook服务端点相关的所有环境变量的示例代码。最小需求的变量是 MINIO_NOTIFY_WEBHOOK_ENABLE 和 MINIO_NOTIFY_WEBHOOK_ENDPOINT:

   export MINIO_NOTIFY_WEBHOOK_ENABLE_<IDENTIFIER>="on"
   export MINIO_NOTIFY_WEBHOOK_ENDPOINT_<IDENTIFIER>="ENDPOINT"
   export MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_WEBHOOK_QUEUE_DIR_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_WEBHOOK_CLIENT_CERT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_WEBHOOK_CLIENT_KEY_<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 Service for Bucket Notifications 以获取关于每个环境变量的完整文档。

Configuration Settings

MinIO 支持在运行中的 minio server 进程上使用 mc admin config set 命令和 notify_webhook 配置键添加或更新 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>"

将 IDENTIFIER 替换为 Webhook 服务端点的唯一描述性字符串。此过程中的以下示例假设标识符为 PRIMARY 。

如果指定的 IDENTIFIER 与 MinIO 部署上现有的 Webhook 服务端点匹配，新的设置将覆盖该端点上任何现有的设置。使用 mc admin config get notify_webhook 查看 MinIO 部署上当前配置的 Webhook 端点。
将 ENDPOINT 替换为 Webhook 服务端点的 URL。例如：

https://webhook.example.com

请参阅 Webhook Bucket Notification Configuration Settings 以获取详细信息。

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 资源。

Identifying the ARN for your bucket notifications

在创建端点之前，您定义了 <IDENTIFIER> 以便为您的存储桶通知分配目标ARN。以下是返回部署上配置的ARNs的步骤：识别之前创建的ARN，请查找您指定的 <IDENTIFIER> 。

查看 JSON 输出

复制并运行以下命令，将 ALIAS 替换为部署的别名。
```
mc admin info --json ALIAS
```
在JSON输出中，查找键 info.sqsARN 。

您需要的ARN是匹配您指定的 <IDENTIFIER> 的该键的值。

例如, arn:minio:sqs::primary:webhook.

使用 jq 解析 JSON 中的值

Install jq
复制并运行以下命令，将 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 服务中检查通知数据。所需操作取决于在配置桶通知时指定的 事件类型。

例如，如果桶通知配置包括 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 是用于 MinIO 服务器配置中桶通知 Webhook 的顶级配置键。 minio-server-config-bucket-notification-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>"

notify_webhook endpoint 配置设置是 Webhook 服务端点的最低要求。所有其他配置设置都是 可选的。请参阅 minio-server-config-bucket-notification-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 服务以获取通知数据。所需操作取决于在配置桶通知时指定的哪些 事件。

例如，如果桶通知配置包括 s3:ObjectCreated:Put 事件，您可以使用 mc cp 命令在桶中创建一个新对象并触发通知。

mc cp ~/data/new-object.txt ALIAS/BUCKET

商业支持购买咨询

将事件发布至Webhook

将 Webhook 端点添加到 MinIO 部署

先决条件

MinIO mc 命令行工具

1) 将 Webhook 端点添加到 MinIO

2) 重新启动MinIO部署。

3) 使用 Webhook 端点作为目标配置桶通知

4) 验证配置的事件

更新 MinIO 部署中的 Webhook 端点

先决条件

MinIO mc 命令行工具

1) 列出部署中配置的 Webhook 端点

2) 更新 Webhook 端点

3) 重新启动MinIO部署。

4) 验证更改

MinIO `mc` 命令行工具

MinIO `mc` 命令行工具