文档

将事件发布到 NSQ

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

向 MinIO 部署添加 NSQ 端点

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

先决条件

MinIO mc 命令行工具

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

1) 向 MinIO 添加 NSQ 端点

您可以使用环境变量运行时配置设置来配置新的 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>替换为TARGET服务端点的唯一描述性字符串。对于与新的目标服务端点相关的所有环境变量,使用相同的<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桶通知配置设置

2) 重新启动MinIO部署

必须重新启动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

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

4) 验证配置的事件

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

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

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

更新MinIO部署中的NSQ端点

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

先决条件

MinIO mc命令行工具

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

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

使用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 服务端点的标识符。

2) 更新 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>"

notify_nsq nsqd_address 配置设置是 NSQ 服务端点的最低要求。所有其他配置设置都是可选的。有关 NSQ 配置设置的完整列表,请参见 NSQ 通知设置

3) 重启 MinIO 部署

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

mc admin service restart ALIAS

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

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

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

4) 验证更改

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

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

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