文档

将事件发布到 Redis

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

将 Redis 端点添加到 MinIO 部署

以下步骤将在 MinIO 部署中添加一个新的 Redis 服务端点,用于支持存储桶通知

先决条件

MinIO mc 命令行工具

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

1) 将 Redis 端点添加到 MinIO

您可以使用环境变量设置运行时配置设置来配置新的 Redis 服务端点。

MinIO 支持使用环境变量指定 Redis 服务端点和相关的配置设置。在下次启动时,minio server 进程将应用指定的设置。

以下示例代码设置了与配置 Redis 服务端点相关的所有环境变量。最小的必需变量是

set MINIO_NOTIFY_REDIS_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_REDIS_ADDRESS_<IDENTIFIER>="<ENDPOINT>"
set MINIO_NOTIFY_REDIS_KEY_<IDENTIFIER>="<STRING>"
set MINIO_NOTIFY_REDIS_FORMAT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_REDIS_PASSWORD_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_REDIS_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_REDIS_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_REDIS_COMMENT_<IDENTIFIER>="<string>"
  • 用 TARGET 服务端点的唯一描述性字符串替换<IDENTIFIER>。对与新目标服务端点相关的所有环境变量使用相同的<IDENTIFIER>值。以下示例假设标识符为PRIMARY

    如果指定的<IDENTIFIER>与 MinIO 部署中现有的 Redis 服务端点匹配,则新设置将覆盖该端点的任何现有设置。使用mc admin config get notify_redis查看 MinIO 部署中当前配置的 Redis 端点。

  • 用 Redis 服务端点的 URL 替换<ENDPOINT>。例如:https://redis.example.com:6369

请参阅用于存储桶通知的 Redis 服务,了解每个环境变量的完整文档。

MinIO 支持在运行的 minio server 进程中添加或更新 Redis 端点,使用 mc admin config set 命令和 notify_redis 配置键。您必须重启 minio server 进程以应用任何新的或更新的配置设置。

以下示例代码设置了与配置 Redis 服务端点相关的所有设置。最低所需的设置是

mc admin config set ALIAS/ notify_redis:IDENTIFIER \
  address="ENDPOINT" \
  key="<string>" \
  format="<string>" \
  password="<string>" \
  queue_dir="<string>" \
  queue_limit="<string>" \
  comment="<string>"
  • 用唯一描述性字符串替换 IDENTIFIER 以标识 Redis 服务端点。本流程中的以下示例假设标识符为 PRIMARY

    如果指定的 IDENTIFIER 与 MinIO 部署中现有的 Redis 服务端点匹配,则新设置将覆盖该端点的所有现有设置。使用 mc admin config get notify_redis 查看 MinIO 部署中当前配置的 Redis 端点。

  • 用 Redis 服务端点的 URL 替换 ENDPOINT。例如:https://redis.example.com:6369

请参阅 Redis 桶通知配置设置,获取有关每个设置的完整文档。

2) 重启 MinIO 部署

您必须重启 MinIO 部署以应用配置更改。使用 mc admin service restart 命令重启部署。

mc admin service restart ALIAS

用要重启的部署的 别名 替换 ALIAS

minio server 进程启动时,它会为每个配置的 Redis 目标打印一行,类似于以下内容

SQS ARNs: arn:minio:sqs::primary:redis

您必须在使用关联的 Redis 部署作为目标配置桶通知时指定 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:redis

使用 jq 解析 JSON 以获取值

  1. 安装 jq

  2. 复制并运行以下命令,用部署的 别名 替换 ALIAS

    mc admin info --json ALIAS | jq  .info.sqsARN
    

    这将返回用于通知的 ARN,例如 arn:minio:sqs::primary:redis

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

使用 mc event add 命令添加一个新的桶通知事件,并将配置的 Redis 服务作为目标

mc event add ALIAS/BUCKET arn:minio:sqs::primary:redis \
  --event EVENTS
  • 用 MinIO 部署的 别名 替换 ALIAS

  • 用要配置事件的桶的名称替换 BUCKET

  • 用逗号分隔的 事件 列表替换 EVENTS,MinIO 将为此触发通知。

使用 mc event ls 查看为给定通知目标配置的所有桶事件

mc event ls ALIAS/BUCKET arn:minio:sqs::primary:redis

4) 验证配置的事件

对您为其配置了新事件的桶执行操作,并检查 Redis 服务以获取通知数据。所需的操作取决于配置桶通知时指定的 事件

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

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

更新 MinIO 部署中的 Redis 端点

以下步骤说明了如何在 MinIO 部署中更新现有 Redis 服务端点,以支持 桶通知

先决条件

MinIO mc 命令行工具

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

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

使用 mc admin config get 命令列出部署中当前配置的 Redis 服务端点

mc admin config get ALIAS/ notify_redis

用 MinIO 部署的 别名 替换 ALIAS

命令输出类似于以下内容

notify_redis:primary address="https://redis.example.com:6369" format="namespace" key="minioevent" password="" queue_dir="" queue_limit="0"
notify_redis:secondary address="https://redis.example.com:6369" format="namespace" key="minioevent" password="" queue_dir="" queue_limit="0"

notify_redisRedis 通知设置 的顶级配置键。键 address 指定给定 notify_redis 键的 Redis 服务端点。后缀 notify_redis:<IDENTIFIER> 描述该 Redis 服务端点的唯一标识符。

注意要更新的 Redis 服务端点的标识符,以备下一步使用。

2) 更新 Redis 端点

使用 mc admin config set 命令设置 Redis 服务端点的新的配置

mc admin config set ALIAS/ notify_redis:IDENTIFIER \
   address="ENDPOINT" \
   key="<string>" \
   format="<string>" \
   password="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"

配置设置 notify_redis address 是 Redis 服务端点的最低要求。所有其他配置设置都是可选的。请参阅 Redis 通知设置,获取 Redis 配置设置的完整列表。

3) 重启 MinIO 部署

您必须重启 MinIO 部署以应用配置更改。使用 mc admin service restart 命令重启部署。

mc admin service restart ALIAS

用要重启的部署的 别名 替换 ALIAS

minio server 进程启动时,它会为每个配置的 Redis 目标打印一行,类似于以下内容

SQS ARNs: arn:minio:sqs::primary:redis

4) 验证更改

对使用更新的 Redis 服务端点配置了事件的桶执行操作,并检查 Redis 服务以获取通知数据。所需的操作取决于配置桶通知时指定的 事件

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

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