文档

NATS 通知设置

NATS Streaming 已弃用

NATS Streaming 已弃用。请改为迁移到 JetStream

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

此页面记录了将 NATS 服务配置为 桶通知 目标的设置。有关使用这些设置的教程,请参阅 将事件发布到 NATS

您可以通过定义以下内容来建立或修改设置

  • 在启动或重新启动 MinIO 服务器之前,在主机系统上定义一个环境变量。有关如何定义环境变量,请参阅您的操作系统的文档。

  • 使用 mc admin config set 定义一个配置设置

  • 使用 MinIO 控制台的 管理员 > 设置 页面定义一个配置设置

如果您同时定义了环境变量和类似的配置设置,MinIO 将使用环境变量的值。

某些设置只有环境变量或配置设置,但不会同时存在。

重要

每个配置设置都会控制 MinIO 的基本行为和功能。MinIO 强烈建议在将配置更改应用于生产环境之前,在较低的环境(如 DEV 或 QA)中进行测试。

多个 NATS 目标

您可以通过在顶级键上附加一个唯一的标识符 _ID 来为每个相关的 NATS 设置集指定多个 NATS 服务端点。

示例

例如,以下命令将两个不同的 NATS 服务端点分别设置为 PRIMARYSECONDARY

set MINIO_NOTIFY_NATS_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_NATS_ADDRESS_PRIMARY="nats-endpoint.example.net:4222"

set MINIO_NOTIFY_NATS_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_NATS_ADDRESS_SECONDARY="nats-endpoint.example.net:4222"

使用这些设置,MINIO_NOTIFY_NATS_ENABLE_PRIMARY 表示环境变量与 ID 为 PRIMARY 的 NATS 服务端点相关联。

mc admin config set notify_nats:primary \
   address="nats-endpoint.example.com:4222" \
   subject="minioevents" \
   [ARGUMENT=VALUE ...]

mc admin config set notify_nats:secondary \
   address="nats-endpoint.example.com:4222" \
   subject="minioevents" \
   [ARGUMENT=VALUE ...]

设置

启用

必需

MINIO_NOTIFY_NATS_ENABLE

指定 on 以启用将桶通知发布到 NATS 服务端点。

默认值为 off

notify_nats

用于定义 NATS 服务端点以用于 MinIO 桶通知 的顶级配置键。

使用 mc admin config set 设置或更新 NATS 服务端点。 addresssubject 参数对于每个目标都是必需的。 将其他可选参数指定为以空格 (" ") 分隔的列表。

mc admin config set notify_nats \
  address="nats-endpoint.example.com:4222" \
  subject="minioevents" \
  [ARGUMENT="VALUE"] ... \

地址

必需

MINIO_NOTIFY_NATS_ADDRESS
notify_nats address

指定 MinIO 发布桶事件的 NATS 服务端点。 例如,nats-endpoint.example.com:4222

在版本 RELEASE.2023-05-27T05-56-19Z 中更改: MinIO 在添加目标之前检查指定 URL 的运行状况(如果它可解析且可达)。 如果现有目标脱机,MinIO 不会再阻止添加新的通知目标。

主题

必需

MINIO_NOTIFY_NATS_SUBJECT
notify_nats subject

指定 MinIO 将发布到 NATS 端点的事件关联到的订阅。

用户名

可选

MINIO_NOTIFY_NATS_USERNAME
notify_nats username

指定连接到 NATS 服务端点的用户名。

密码

可选

MINIO_NOTIFY_NATS_PASSWORD
notify_nats password

指定连接到 NATS 服务端点的密码。

在版本 RELEASE.2023-06-23T20-26-00Z 中更改: MinIO 在作为 mc admin config get 的一部分返回时会屏蔽此值。

令牌

可选

MINIO_NOTIFY_NATS_TOKEN
notify_nats token

指定连接到 NATS 服务端点的令牌。

在版本 RELEASE.2023-06-23T20-26-00Z 中更改: MinIO 在作为 mc admin config get 的一部分返回时会屏蔽此值。

用户凭证文件

可选

MINIO_NOTIFY_NATS_USER_CREDENTIALS
notify_nats user_credentials

指定要用于连接到 NATS 服务端点的 用户凭证文件 <https://docs.nats.io/using-nats/developer/connecting/creds>

TLS

可选

MINIO_NOTIFY_NATS_TLS
notify_nats tls

指定 on 以启用与 NATS 服务端点的 TLS 连接。

TLS 跳过验证

可选

MINIO_NOTIFY_NATS_TLS_SKIP_VERIFY
notify_nats tls_skip_verify

启用或禁用 NATS 服务端点 TLS 证书的 TLS 验证。

  • 指定 on 以禁用 TLS 验证(默认)。

  • 指定 off 以启用 TLS 验证。

Ping 间隔

可选

MINIO_NOTIFY_NATS_PING_INTERVAL
notify_nats ping_interval

指定客户端 ping NATS 服务器的持续时间间隔。 MinIO 支持以下时间单位

  • s - 秒,"60s"

  • m - 分钟,"5m"

  • h - 小时,"1h"

  • d - 天,"1d"

Jetstream

可选

MINIO_NOTIFY_NATS_JETSTREAM
notify_nats jetstream

指定 on 以启用 JetStream 支持,以将事件流式传输到 NATS JetStream 服务端点。

流式传输

已弃用

可选

MINIO_NOTIFY_NATS_STREAMING
notify_nats streaming

指定 on 以启用将事件异步发布到 NATS 服务端点。

流式传输异步

已弃用

可选

MINIO_NOTIFY_NATS_STREAMING_ASYNC
notify_nats streaming_async

指定 on 以启用将事件异步发布到 NATS 服务端点。

在飞行中的最大 ACK 响应数

已弃用

可选

MINIO_NOTIFY_NATS_STREAMING_MAX_PUB_ACKS_IN_FLIGHT
notify_nats streaming_max_pub_acks_in_flight

指定在等待 NATS 服务端点 ACK 响应之前要发布的消息数量。

流式传输集群 ID

已弃用

可选

MINIO_NOTIFY_NATS_STREAMING_CLUSTER_ID
notify_nats streaming_cluster_id

指定 NATS 流式传输集群的唯一 ID。

证书颁发机构

可选

MINIO_NOTIFY_NATS_CERT_AUTHORITY
notify_nats cert_authority

指定用于签署 NATS 服务端点 TLS 证书的证书颁发机构链的路径。

客户端证书

可选

MINIO_NOTIFY_NATS_CLIENT_CERT
notify_nats client_cert

指定用于对 NATS 服务端点执行 mTLS 身份验证的客户端证书的路径。

客户端密钥

可选

MINIO_NOTIFY_NATS_CLIENT_KEY
notify_nats client_key

指定用于对 NATS 服务端点执行 mTLS 身份验证的客户端私钥路径。

队列目录

可选

MINIO_NOTIFY_NATS_QUEUE_DIR
notify_nats queue_dir

指定目录路径以启用 MinIO 的持久事件存储以用于未传递的消息,例如 /opt/minio/events

当 NATS 服务器/代理处于离线状态时,MinIO 会将未传递的事件存储在指定的存储中,并在连接恢复时重播存储的事件。

队列限制

可选

MINIO_NOTIFY_NATS_QUEUE_LIMIT
notify_nats queue_limit

指定未传递消息的最大限制。默认值为 100000

评论

可选

MINIO_NOTIFY_NATS_COMMENT
notify_nats comment

指定与 NATS 配置关联的注释。