文档

将事件发布到 AMQP(RabbitMQ)

MinIO 支持将 存储桶通知 事件发布到诸如 AMQP 0-9-1 服务端点之类的 RabbitMQ

MinIO 依赖于 https://github.com/streadway/amqp 项目进行 AMQP 连接。该项目主要针对 RabbitMQ 部署进行了测试,但其他 与 AMQP 0-9-1 兼容 的服务可能也能正常工作。本页面的步骤假设使用 AMQP 0-9-1 协议作为服务端点的 RabbitMQ 部署。

向 MinIO 部署添加 AMQP 端点

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

先决条件

AMQP 0-9-1 服务端点

MinIO 依赖于 https://github.com/streadway/amqp 项目进行 AMQP 连接。该项目主要针对 RabbitMQ 部署进行了测试,但其他 与 AMQP 0-9-1 兼容 的服务可能也能正常工作。本步骤假设使用 0-9-1 协议作为服务端点的 RabbitMQ 部署。

如果 AMQP 服务需要身份验证,您必须在配置过程中提供相应的用户名和密码,以授予 MinIO 访问该服务的权限。

MinIO mc 命令行工具

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

1) 将 AMQP 端点添加到 MinIO

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

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

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

set MINIO_NOTIFY_AMQP_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_AMQP_URL_<IDENTIFIER>="<ENDPOINT>"
set MINIO_NOTIFY_AMQP_EXCHANGE_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_EXCHANGE_TYPE_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_ROUTING_KEY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_MANDATORY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_DURABLE_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_NO_WAIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_INTERNAL_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_AUTO_DELETED_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_DELIVERY_MODE_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_AMQP_COMMENT_<IDENTIFIER>="<string>"
  • <IDENTIFIER> 替换为 AMQP 服务端点的唯一描述性字符串。 对与新 AMQP 服务端点相关的所有环境变量使用相同的 <IDENTIFIER> 值。 以下示例假设标识符为 PRIMARY

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

  • <ENDPOINT> 替换为 AMQP 服务端点的 URL。 例如

    amqp://user:password@hostname:port

请参阅 用于桶通知的 AMQP 服务 以获取每个环境变量的完整文档。

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

以下示例代码设置了与配置 AMQP 服务端点相关的所有设置。 最小 _必需_ 设置是 notify_amqp url

mc admin config set ALIAS/ notify_amqp:IDENTIFIER \
  url="ENDPOINT" \
  exchange="<string>" \
  exchange_type="<string>" \
  routing_key="<string>" \
  mandatory="<string>" \
  durable="<string>" \
  no_wait="<string>" \
  internal="<string>" \
  auto_deleted="<string>" \
  delivery_mode="<string>" \
  queue_dir="<string>" \
  queue_limit="<string>" \
  comment="<string>"
  • IDENTIFIER 替换为 AMQP 服务端点的唯一描述性字符串。 本过程中的以下示例假设标识符为 PRIMARY

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

  • ENDPOINT 替换为 AMQP 服务端点的 URL。 例如

    amqp://user:password@hostname:port

请参阅 AMQP 桶通知配置设置 以获取每个设置的完整文档。

2) 重新启动 MinIO 部署

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

mc admin service restart ALIAS

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

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

SQS ARNs: arn:minio:sqs::primary:amqp

您必须在使用关联的 AMQP 部署作为目标配置桶通知时指定 ARN 资源。

识别桶通知的 ARN

您之前在创建端点时定义了 <IDENTIFIER> 来分配给桶通知的目标 ARN。 以下步骤将返回部署中配置的 ARN。 通过查找您指定的 <IDENTIFIER> 来识别之前创建的 ARN。

查看 JSON 输出

  1. 复制并运行以下命令,将 ALIAS 替换为部署的 别名

    mc admin info --json ALIAS
    
  2. 在 JSON 输出中,查找键 info.sqsARN

    您需要的 ARN 是与您指定的 <IDENTIFIER> 匹配的该键的值。

    例如,arn:minio:sqs::primary:amqp

使用 jq 解析 JSON 以获取该值

  1. 安装 jq

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

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

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

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

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

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

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

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

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

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

4) 验证配置的事件

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

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

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

在 MinIO 部署中更新 AMQP 端点

以下步骤介绍了如何更新现有 AMQP 服务端点,以便在 MinIO 部署中支持 桶通知

先决条件

AMQP 0-9-1 服务端点

MinIO 依赖于 https://github.com/streadway/amqp 项目来实现 AMQP 连接。该项目主要针对 RabbitMQ 部署进行测试,但其他 兼容 AMQP 0-9-1 的服务可能也能正常工作。本步骤假设使用 RabbitMQ 部署作为服务端点。

如果 AMQP 服务需要身份验证,您必须在配置过程中提供相应的用户名和密码,以授予 MinIO 访问该服务的权限。

MinIO mc 命令行工具

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

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

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

mc admin config get ALIAS/ notify_amqp

ALIAS 替换为 MinIO 部署的 别名

命令输出类似于以下内容:

notify_amqp:primary delivery_mode="0" exchange_type="" no_wait="off" queue_dir="" queue_limit="0"  url="amqp://user:password@hostname:port" auto_deleted="off" durable="off" exchange="" internal="off" mandatory="off" routing_key=""
notify_amqp:secondary delivery_mode="0" exchange_type="" no_wait="off" queue_dir="" queue_limit="0"  url="amqp://user:password@hostname:port" auto_deleted="off" durable="off" exchange="" internal="off" mandatory="off" routing_key=""

notify_amqp 键是 AMQP 通知设置 的顶级配置键。 url 键指定了给定 notify_amqp 键的 AMQP 服务端点。 notify_amqp:<IDENTIFIER> 后缀描述了该 AMQP 服务端点的唯一标识符。

请注意要更新的 AMQP 服务端点的标识符,以便在下一步使用。

2) 更新 AMQP 端点

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

mc admin config set ALIAS/ notify_amqp:<IDENTIFIER> \
   url="amqp://user:password@hostname:port" \
   exchange="<string>" \
   exchange_type="<string>" \
   routing_key="<string>" \
   mandatory="<string>" \
   durable="<string>" \
   no_wait="<string>" \
   internal="<string>" \
   auto_deleted="<string>" \
   delivery_mode="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"

notify_amqp url 配置设置是 AMQP 服务端点所需的最低设置。所有其他配置设置都是可选的。请参阅 AMQP 通知设置 以获取 AMQP 配置设置的完整列表。

3) 重新启动 MinIO 部署

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

mc admin service restart ALIAS

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

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

SQS ARNs: arn:minio:sqs::primary:amqp

4) 验证更改

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

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

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