混合云对象存储
祼机
纠删码计算器
参考硬件
将事件发布到 Webhook
Table of Contents
MinIO 支持发布 bucket notification 事件到 Webhook 服务端点。
将 Webhook 端点添加到 MinIO 部署
以下过程添加了一个新的 Webhook 服务端点以支持 bucket notifications 在一个 MinIO 部署。
Important
这个程序 requires 全部重启 minio server 流程
同时与部署相关联。 通常有一个简短的 API 操作中断或可能失败的时间段。
使用带有内置重试逻辑的 S3 兼容 SDK 的应用程序 or 实现手动重试逻辑通常不会遇到明显的中断 服务。 对于不能使用重试逻辑的应用，考虑调度 一个维护期，以尽量减少在执行时服务的中断这个程序。
先决条件
MinIO mc 命令行工具
此过程使用 mc 用于某些操作的命令行工具。
见 mc Quickstart 安装说明。
1) 将 Webhook 端点添加到 MinIO
您可以使用任一环境配置新的 Webhook 服务端点 变量 or 通过设置运行时配置设置。
MinIO 支持指定 Webhook 服务端点和关联
配置设置使用
environment variables. The
minio server 进程在其上应用指定的设置
下次启动。
以下示例代码设置了 all 环境变量 与配置 Webhook 服务端点相关。 最低 required 变量是
MINIO_NOTIFY_WEBHOOK_ENABLE and
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>`` 匹配现有的 Webhook 服务 MinIO 部署上的端点，新设置 override 该端点的任何现有设置。 用
mc admin config get notify_webhook查看 MinIO 部署上当前配置的 Webhook 端点。将
<ENDPOINT>替换为 Webhook 服务端点的 URL。 例如:https://webhook.example.com
见 Webhook Service for Bucket Notifications 完整的文档 在每个环境变量上。
MinIO 支持在运行时添加或更新 Webhook 端点
minio server process using the mc admin config set 命令
和 notify_webhook 配置键。 您必须重新启动
minio server 应用任何新的或更新的配置的过程
设置。
以下示例代码设置了与配置相关的 all 设置
Webhook 服务端点。 最小 required 设置是
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” 与现有的 Webhook 服务匹配 MinIO 部署上的端点，新设置 override 该端点的任何现有设置。 用
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” 替换为 alias 部署到
重新开始。
The minio server 进程在启动时为每个配置打印一行
类似于以下的 Webhook 目标:
SQS ARNs: arn:minio:sqs::primary:webhook
您必须在配置存储通知时指定 ARN 资源 关联的 Webhook 部署作为目标。
3) 使用 Webhook 端点作为目标配置存储通知
使用 mc event add 添加新存储通知的命令
以配置的 Webhook 服务为目标的事件:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:webhook \
--event EVENTS
将 “ALIAS” 替换为
alias一个 MinIO 部署。将
BUCKET替换为要在其中配置存储的名称事件。用逗号分隔的列表替换 “EVENTS” events MinIO 为其触发通知。
用 mc event list 查看所有配置的存储事件
给定的通知目标:
mc event list 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 服务端点以支持 bucket notifications 在一个 MinIO 部署。
Important
这个程序 requires 全部重启 minio server 流程
同时与部署相关联。 通常有一个简短的 API 操作中断或可能失败的时间段。
使用带有内置重试逻辑的 S3 兼容 SDK 的应用程序 or 实现手动重试逻辑通常不会遇到明显的中断 服务。 对于不能使用重试逻辑的应用，考虑调度 一个维护期，以尽量减少在执行时服务的中断这个程序。
先决条件
MinIO mc 命令行工具
此过程使用 mc 用于某些操作的命令行工具。
见 mc Quickstart 安装说明。
1) 列出部署中已配置的 Webhook 端点
使用 mc admin config get 命令列出当前
在部署中配置的 Webhook 服务端点:
mc admin config get ALIAS/ notify_webhook
将 “ALIAS” 替换为 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=""
The notify_webhook key 是一个顶级配置键
用于存储桶通知的 Webhook 服务. The
endpoint key 指定 Webhook 服务
给定 notify_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>"
The notify_webhook endpoint 配置
设置是 Webhook 服务端点所需的 minimum 。 所有其他
配置设置是 optional。 看
用于存储桶通知的 Webhook 服务 完整列表
网络钩子配置设置。
3) 重启 MinIO 部署
您必须重新启动 MinIO 部署才能应用配置更改。
使用 mc admin service restart 命令重新启动部署。
mc admin service restart ALIAS
将 “ALIAS” 替换为 alias 部署到
重新开始。
The minio server 进程在启动时为每个配置的 Webhook 打印一行
目标类似于以下:
SQS ARNs: arn:minio:sqs::primary:webhook
3) 验证更改
使用更新的事件配置对具有事件配置的存储执行操作
Webhook 服务端点并检查 Webhook 服务以获取通知
数据。 所需的操作取决于哪个 events
在配置存储通知时指定。
例如，如果存储通知配置包括
s3:ObjectCreated:Put 事件，您可以使用
mc cp 命令在存储中创建一个新对象并触发
通知。
mc cp ~/data/new-object.txt ALIAS/BUCKET