文档

将事件发布到 Elasticsearch

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

MinIO 依赖于https://github.com/elastic/go-elasticsearch v7 项目来实现 Elastic 连接。

将 Elasticsearch 端点添加到 MinIO 部署

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

先决条件

Elasticsearch v7.0 及更高版本

MinIO 依赖于https://github.com/olivere/elastic v7 项目来实现 Elastic 连接。elastic/v7 库专门针对 Elasticsearch v7.0,并且与之前的 Elasticsearch 版本不兼容

MinIO mc 命令行工具

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

1) 将 Elasticsearch 端点添加到 MinIO

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

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

以下示例代码设置了与配置 Elasticsearch 服务端点相关的所有环境变量。最少需要的变量是

set MINIO_NOTIFY_ELASTICSEARCH_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_ELASTICSEARCH_URL_<IDENTIFIER>="<ENDPOINT>"
set MINIO_NOTIFY_ELASTICSEARCH_INDEX_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_ELASTICSEARCH_FORMAT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_ELASTICSEARCH_USERNAME_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_ELASTICSEARCH_PASSWORD_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_ELASTICSEARCH_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_ELASTICSEARCH_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_ELASTICSEARCH_COMMENT_<IDENTIFIER>="<string>"
  • 用唯一描述性的字符串替换 <IDENTIFIER>,用于 TARGET 服务端点。对与新目标服务端点相关的所有环境变量使用相同的 <IDENTIFIER> 值。以下示例假设标识符为 PRIMARY

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

  • 用 Elasticsearch 服务端点的 URL 替换 <ENDPOINT>。例如

请参阅 用于桶通知的 Elasticsearch 服务,了解每个环境变量的完整文档。

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

以下示例代码设置了与配置 Elasticsearch 服务端点相关的所有设置。最少需要的设置是

mc admin config set ALIAS/ notify_elasticsearch:IDENTIFIER \
   url="ENDPOINT" \
   index="<string>" \
   format="<string>" \
   username="<string>" \
   password="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"
  • 用唯一描述性的字符串替换 IDENTIFIER,用于 Elasticsearch 服务端点。本步骤中的以下示例假设标识符为 PRIMARY

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

  • 用 Elasticsearch 服务端点的 URL 替换 ENDPOINT。例如

    https://user:password@hostname:port

请参阅 Elasticsearch 桶通知配置设置,了解每个设置的完整文档。

2) 重启 MinIO 部署

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

mc admin service restart ALIAS

用部署的 别名 替换 ALIAS 以重启。

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

SQS ARNs: arn:minio:sqs::primary:elasticsearch

您必须在将关联的 Elasticsearch 部署配置为目标时,使用 ARN 资源来配置桶通知。

识别您的桶通知的 ARN

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

查看 JSON 输出

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

    mc admin info --json ALIAS
    
  2. 在 JSON 输出中,查找键 info.sqsARN

    您需要的 ARN 是与您指定的 <IDENTIFIER> 匹配的该键的值。

    例如,arn:minio:sqs::primary:elasticsearch

使用 jq 解析 JSON 以获取值

  1. 安装 jq

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

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

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

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

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

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

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

  • 用 MinIO 触发通知的 事件 的逗号分隔列表替换 EVENTS

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

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

4) 验证配置的事件

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

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

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

更新 MinIO 部署中的 Elasticsearch 端点

以下步骤更新了现有 Elasticsearch 服务端点,用于在 MinIO 部署中支持 桶通知

先决条件

Elasticsearch v7.0 及更高版本

MinIO 依赖于https://github.com/olivere/elastic v7 项目来实现 Elastic 连接。elastic/v7 库专门针对 Elasticsearch v7.0,并且与之前的 Elasticsearch 版本不兼容

MinIO mc 命令行工具

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

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

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

mc admin config get ALIAS/ notify_elasticsearch

ALIAS 替换为 MinIO 部署的 别名

命令输出类似于以下内容

notify_elasticsearch:primary  queue_dir="" queue_limit="0"  url="https://user:password@hostname:port" format="namespace" index=""
notify_elasticsearch:secondary queue_dir="" queue_limit="0"  url="https://user:password@hostname:port" format="namespace" index=""

The notify_elasticsearch 密钥是 Elasticsearch 通知设置 的顶级配置密钥。The url 密钥指定了给定 notify_elasticsearch 密钥的 Elasticsearch 服务端点。notify_elasticsearch:<IDENTIFIER> 后缀描述了该 Elasticsearch 服务端点的唯一标识符。

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

2) 更新 Elasticsearch 端点

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

mc admin config set ALIAS/ notify_elasticsearch:<IDENTIFIER> \
   url="https://user:password@hostname:port" \
   index="<string>" \
   format="<string>" \
   username="<string>" \
   password="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"

The notify_elasticsearch url 配置设置是 Elasticsearch 服务端点所需的 *最少* 配置。所有其他配置设置都是 *可选* 的。请参阅 Elasticsearch 通知设置 了解 Elasticsearch 配置设置的完整列表。

3) 重启 MinIO 部署

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

mc admin service restart ALIAS

用部署的 别名 替换 ALIAS 以重启。

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

SQS ARNs: arn:minio:sqs::primary:elasticsearch

4) 验证更改

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

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

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