中文文档

MinIO 支持将 bucket notification 事件发布到一个 Elasticsearch 服务端点。

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

将 Elasticsearch 端点添加到 MinIO 部署

以下步骤将向MinIO部署中添加一个新的Elasticsearch服务端点, 以支持:ref:bucket notifications <minio-bucket-notifications> 部署。

先决条件

Elasticsearch v7.0 及更高版本

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

MinIO mc 命令行工具

此过程使用 mc 命令行工具执行某些操作。 请参阅 mc 的 快速入门 以获取安装说明。

1) 将Elasticsearch端点添加到MinIO

您可以通过设置环境变量 或 运行时配置设置 来配置一个新的Elasticsearch服务端点。

MinIO 支持指定 Elasticsearch 服务端点和关联的 配置设置使用 环境变量. 当您设置环境变量后,minio server 进程将在下一次启动时 应用这些设置。

以下示例代码设置了与配置 Elasticsearch 服务端点 相关的 所有 环境变量。 最少 必须的 变量包括:

  • MINIO_NOTIFY_ELASTICSEARCH_ENABLE

  • MINIO_NOTIFY_ELASTICSEARCH_URL

  • MINIO_NOTIFY_ELASTICSEARCH_INDEX

  • MINIO_NOTIFY_ELASTICSEARCH_FORMAT

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

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

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

请参阅 Elasticsearch Service for Bucket Notifications 以获取有关每个环境变量的完整文档。

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

以下示例代码设置了与配置 Elasticsearch 服务端点 相关的 所有 设置。 最小 必需 设置包括:

  • url

  • index

  • format

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 。

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

  • 将 ENDPOINT 替换为Elasticsearch服务端点的URL。 例如:

    https://user:password@hostname:port

有关每个设置的完整文档,请参阅 Elasticsearch Bucket Notification Configuration Settings

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资源。

Identifying the ARN for your bucket notifications

在创建端点之前,您定义了 <IDENTIFIER> 以便为您的存储桶通知分配目标ARN。 以下是返回部署上配置的ARNs的步骤: 识别之前创建的ARN,请查找您指定的 <IDENTIFIER> 。

查看 JSON 输出

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

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

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

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

使用 jq 解析 JSON 中的值

  1. Install 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
  • 将 ALIAS 替换为MinIO部署的 别名。

  • 将 BUCKET 替换为您要配置事件的桶的 名称。

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

使用 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端点。

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

先决条件

从Elasticsearch v7.0开始及以后的版本。

MinIO 依赖于 https://github.com/olivere/elastic v7 项目来实现与Elasticsearch的 连接。 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 是一个顶级配置键, 用于 minio-server-config-bucket-notification-elasticsearch 。 url 键指定了给定 notify_elasticsearch 键的Elasticsearch服务端点。 The 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>"

notify_elasticsearch url 配置设置是 Elasticsearch服务端点所需的 最少 配置。 所有其他配置设置都是 可选的。 请参阅 minio-server-config-bucket-notification-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
Join Slack 商业支持购买咨询