文档

将事件发布到 Redis

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

向 MinIO 部署添加 Redis 端点

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

前提条件

MinIO mc 命令行工具

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

1) 将 Redis 端点添加到 MinIO

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

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

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

   export MINIO_NOTIFY_REDIS_ENABLE_<IDENTIFIER>="on"
   export MINIO_NOTIFY_REDIS_ADDRESS_<IDENTIFIER>="<ENDPOINT>"
   export MINIO_NOTIFY_REDIS_KEY_<IDENTIFIER>="<STRING>"
   export MINIO_NOTIFY_REDIS_FORMAT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_REDIS_PASSWORD_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_REDIS_QUEUE_DIR_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_REDIS_QUEUE_LIMIT_<IDENTIFIER>="<string>"
   export 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 存储桶通知配置设置

1) 重启 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
  • 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 端点

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

前提条件

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 替换为要重新启动的部署的别名

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
English 中文