文档

将事件发布到 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>"
  • <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 支持在运行的 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

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

使用 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

用 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_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

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

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

4) 验证更改

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

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

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