文档

将事件发布到 NSQ

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

以下过程会为 MinIO 部署中支持存储桶通知添加一个新的 NSQ 服务端点。

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

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

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

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

set MINIO_NOTIFY_NSQ_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_NSQ_NSQD_ADDRESS_<IDENTIFIER>="<ENDPOINT>"
set MINIO_NOTIFY_NSQ_TOPIC_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NSQ_TLS_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NSQ_TLS_SKIP_VERIFY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NSQ_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NSQ_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NSQ_COMMENT_<IDENTIFIER>="<string>"
  • <IDENTIFIER>替换为目标服务端点的唯一描述性字符串。对与新目标服务端点相关的所有环境变量使用相同的<IDENTIFIER>值。以下示例假设标识符为PRIMARY

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

  • <ENDPOINT> 替换为 NSQ 服务端点的 URL。例如,https://nsq-service.example.com:4150

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

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

以下示例代码设置了与配置 NSQ 服务端点相关的所有设置。最小必需设置是 notify_nsq nsqd_addressnotify_nsq topic

mc admin config set ALIAS/ notify_nsq:IDENTIFIER \
  nsqd_address="ENDPOINT" \
  topic="<string>" \
  tls="<string>" \
  tls_skip_verify="<string>" \
  queue_dir="<string>" \
  queue_limit="<string>" \
  comment="<string>"
  • IDENTIFIER 替换为 NSQ 服务端点的唯一描述性字符串。此过程中的以下示例假设标识符为 PRIMARY

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

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

    NSQ://user:password@hostname:port

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

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

mc admin service restart ALIAS

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

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

SQS ARNs: |ARN|

使用关联的 NSQ 部署作为目标配置存储桶通知时,必须指定 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:nsq

使用 jq 解析 JSON 以获取值

  1. 安装 jq

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

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

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

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

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

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

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

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

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

对您为其配置新事件的存储桶执行操作,并在 NSQ 服务中检查通知数据。所需的操作取决于配置存储桶通知时指定的 事件

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

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

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

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

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

mc admin config get ALIAS/ notify_nsq

ALIAS 替换为 MinIO 部署的 别名

命令输出类似于以下内容

notify_nsq:primary nsqd_address="https://nsq.example.com" queue_dir="" queue_limit="0"  tls="off" tls_skip_verify="off" topic=""
notify_nsq:secondary nsqd_address="https://nsq.example.com" queue_dir="" queue_limit="0"  tls="off" tls_skip_verify="off" topic=""

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

记下您要更新的 NSQ 服务端点的标识符,以备下一步使用。

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

mc admin config set ALIAS/ notify_nsq:<IDENTIFIER> \
   nsqd_address="NSQ://user:password@hostname:port" \
   topic="<string>" \
   tls="<string>" \
   tls_skip_verify="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"

用于 NSQ 服务端点的 notify_nsq nsqd_address 配置设置是必需的。所有其他配置设置都是可选的。有关 NSQ 配置设置的完整列表,请参阅 NSQ 通知设置

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

mc admin service restart ALIAS

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

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

SQS ARNs: arn:minio:sqs::primary:NSQ

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

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

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