文档

将事件发布到 Redis

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

将 Redis 端点添加到 MinIO 部署

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

先决条件

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>"
  • <IDENTIFIER> 替换为 TARGET 服务端点的唯一描述性字符串。为与新目标服务端点相关的所有环境变量使用相同的 <IDENTIFIER> 值。以下示例假设标识符为 PRIMARY

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

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

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

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

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

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

2) 重新启动 MinIO 部署

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

mc admin service restart ALIAS

ALIAS 替换为要重新启动的部署的 别名

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

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
  • ALIAS 替换为 MinIO 部署的 别名

  • BUCKET 替换为要配置事件的存储桶的名称。

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

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

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

4) 验证配置的事件

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

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

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

在 MinIO 部署中更新 Redis 端点

以下过程更新了现有的 Redis 服务端点,以在 MinIO 部署中支持 存储桶通知

先决条件

MinIO mc 命令行工具

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

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

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

mc admin config get ALIAS/ notify_redis

ALIAS 替换为 MinIO 部署的 别名

命令输出类似于以下内容

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_redis 键是 Redis 通知设置 的顶级配置键。 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 替换为要重新启动的部署的 别名

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

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

4) 验证更改

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

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

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