文档基于2025-10-10日社区最终版构建     
切换到英文版    进入演示系统    进入交流社区

MinIO Documentation

发布事件到 NATS

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

NATS Streaming 已弃用

NATS Streaming 已弃用。 请迁移至JetStream相反。

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

向 MinIO 部署添加 NATS 端点

以下过程添加了一个新的NATS服务端点以提供支持存储桶通知在 MinIO 部署中。

前提条件

MinIOmc命令行工具

这个过程使用mc用于特定操作的命令行工具。 请参阅mc 快速入门有关安装说明。

1) 将 NATS 端点添加到 MinIO

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

MinIO支持使用以下方式指定NATS服务端点及相关配置设置:环境变量.minio server进程将在下次启动时应用指定的设置。

以下示例代码设置全部与配置NATS服务端点相关的环境变量。 最低配置要求必需变量是MINIO_NOTIFY_NATS_ADDRESSMINIO_NOTIFY_NATS_SUBJECT:

   export MINIO_NOTIFY_NATS_ENABLE_<IDENTIFIER>="on"
   export MINIO_NOTIFY_NATS_ADDRESS_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_SUBJECT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_USERNAME_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_PASSWORD_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_TOKEN_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_TLS_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_TLS_SKIP_VERIFY_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_PING_INTERVAL_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_QUEUE_DIR_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_QUEUE_LIMIT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_CERT_AUTHORITY_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_CLIENT_CERT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_CLIENT_KEY_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_NATS_COMMENT_<IDENTIFIER>="<string>"
   export 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 支持在运行中添加或更新 NATS 端点minio server使用该过程mc admin config set命令 和notify_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>"
  • 替换IDENTIFIER使用唯一的描述性字符串作为 NATS 服务端点。 本过程中的以下示例假定标识符为PRIMARY.

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

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

NATS Bucket 通知配置设置有关每个设置的完整文档。

1) 重启 MinIO 部署

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

mc admin service restart ALIAS

替换ALIAS随着别名部署的重新启动。

Theminio server进程在启动时会为每个配置的 NATS 目标打印一行信息,类似以下内容:

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

在配置存储桶通知并将关联的 NATS 部署设为目标时,必须指定 ARN 资源。

识别您的存储桶通知的ARN

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

审查 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
  • 替换ALIAS随着别名MinIO 部署的。

  • 替换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 部署中。

前提条件

MinIOmc命令行工具

这个过程使用mc用于特定操作的命令行工具。 请参阅mc 快速入门有关安装说明。

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

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

mc admin config get ALIAS/ notify_nats

替换ALIAS随着别名MinIO 部署的。

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

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"

Thenotify_natskey 是用于配置NATS 通知设置.addresskey 指定了给定服务的 NATS 服务端点notify_natskey. Thenotify_nats:<IDENTIFIER>suffix 描述了该 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>"

Thenotify_nats address配置设置是最小值NATS 服务端点必需。 所有其他配置设置均为可选的.NATS 通知设置有关 NATS 配置设置的完整列表。

3) 重启 MinIO 部署

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

mc admin service restart ALIAS

替换ALIAS随着别名部署的重启。

Theminio 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