文档

将事件发布到 NATS

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

NATS Streaming 已弃用

NATS Streaming 已弃用。迁移到 JetStream

相关的 MinIO 配置选项和环境变量已弃用。

将 NATS 端点添加到 MinIO 部署

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

先决条件

MinIO mc 命令行工具

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

1) 将 NATS 端点添加到 MinIO

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

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

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

set MINIO_NOTIFY_NATS_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_NATS_ADDRESS_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_SUBJECT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_USERNAME_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_PASSWORD_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_TOKEN_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_TLS_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_TLS_SKIP_VERIFY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_PING_INTERVAL_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_CERT_AUTHORITY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_CLIENT_CERT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_CLIENT_KEY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_COMMENT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NATS_JETSTREAM_<IDENTIFIER>="<string>"
  • <IDENTIFIER> 替换为 NATS 服务端点的唯一描述性字符串。对所有与新目标服务端点相关的环境变量使用相同的 <IDENTIFIER> 值。以下示例假定标识符为 PRIMARY

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

  • <ENDPOINT> 替换为 NATS 服务端点的主机名和端口。例如:nats-endpoint.example.com:4222

有关每个环境变量的完整文档,请参见用于桶通知的 NATS 服务

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

以下示例代码设置了与配置 NATS 服务端点相关的所有设置。必需的最小设置是 notify_nats addressnotify_nats subject

mc admin config set ALIAS/ notify_nats:IDENTIFIER \
   address="HOSTNAME" \
   subject="<string>" \
   username="<string>" \
   password="<string>" \
   token="<string>" \
   nats_jetstream="<string>" \
   tls="<string>" \
   tls_skip_verify="<string>" \
   ping_interval="<string>" \
   cert_authority="<string>" \
   client_cert="<string>" \
   client_key="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"
  • 用 NATS 服务端点的唯一描述性字符串替换 IDENTIFIER。本过程中的以下示例假设标识符为 PRIMARY

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

  • 用 NATS 服务端点的主机名和端口替换 ENDPOINT。例如:nats-endpoint.example.com:4222

有关每个设置的完整文档,请参见 NATS 桶通知配置设置

1) 重启 MinIO 部署

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

mc admin service restart ALIAS

用要重启的部署的 别名 替换 ALIAS

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

SQS ARNs: arn:minio:sqs::primary:nats

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

使用 jq 解析 JSON 以获取值

  1. 安装 jq

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

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

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

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

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

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

  • 用要配置事件的桶的名称替换 BUCKET

  • 用逗号分隔的 事件 列表替换 EVENTS,MinIO 会针对这些事件触发通知。

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

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

4) 验证配置的事件

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

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

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

在 MinIO 部署中更新 NATS 端点

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

先决条件

MinIO mc 命令行工具

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

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

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

mc admin config get ALIAS/ notify_nats

用 MinIO 部署的 别名 替换 ALIAS

命令输出类似于以下内容

notify_nats:primary password="yoursecret" subject="" address="nats-endpoint.example.com:4222"  token="" username="yourusername" ping_interval="0" queue_limit="0" tls="off" tls_skip_verify="off" queue_dir="" streaming_enable="on" nats_jetstream="on"
notify_nats:secondary password="yoursecret" subject="" address="nats-endpoint.example.com:4222"  token="" username="yourusername" ping_interval="0" queue_limit="0" tls="off" tls_skip_verify="off" queue_dir="" streaming_enable="on" nats_jetstream="on"

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

注意要为下一步更新的 NATS 服务端点的标识符。

2) 更新 NATS 端点

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

mc admin config set ALIAS/ notify_nats:IDENTIFIER \
   address="HOSTNAME" \
   subject="<string>" \
   username="<string>" \
   password="<string>" \
   token="<string>" \
   tls="<string>" \
   tls_skip_verify="<string>" \
   ping_interval="<string>" \
   nats_jetstream="<string>" \
   cert_authority="<string>" \
   client_cert="<string>" \
   client_key="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"

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

3) 重启 MinIO 部署

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

mc admin service restart ALIAS

用要重启的部署的 别名 替换 ALIAS

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

SQS ARNs: arn:minio:sqs::primary:nats

4) 验证更改

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

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

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