将事件发布到 NATS
MinIO 支持将 存储桶通知 事件发布到 NATS 服务端点。
将 NATS 端点添加到 MinIO 部署
以下过程将为 MinIO 部署中支持 存储桶通知 添加一个新的 NATS 服务端点。
先决条件
MinIO mc 命令行工具
1) 将 NATS 端点添加到 MinIO
您可以使用环境变量或通过设置运行时配置设置来配置新的 NATS 服务端点。
MinIO 支持使用 环境变量 指定 NATS 服务端点和相关配置设置。 minio server 进程将在下次启动时应用指定的设置。
以下示例代码设置了与配置 NATS 服务端点相关的所有环境变量。必需的最小变量是MINIO_NOTIFY_NATS_ADDRESS和MINIO_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 address和notify_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 桶通知配置设置。
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 输出
复制并运行以下命令,将
ALIAS替换为部署的别名。mc admin info --json ALIAS
在 JSON 输出中,查找键
info.sqsARN。您需要的 ARN 是与您指定的
<IDENTIFIER>匹配的该键的值。例如,
arn:minio:sqs::primary:nats。
使用 jq 解析 JSON 以获取值
3) 使用 NATS 端点作为目标配置桶通知
使用mc event add命令添加一个新的桶通知事件,并将配置的 NATS 服务作为目标
mc event add ALIAS/BUCKET arn:minio:sqs::primary:nats \
--event EVENTS
使用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 命令行工具
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"
键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