文件

發佈事件至 Kafka

MinIO 支援將 bucket 通知 事件發佈到 Kafka 服務端點。

MinIO 依賴 https://github.com/Shopify/sarama 專案進行 Kafka 連線,並分享該專案的 Kafka 支援。請參閱 sarama 相容性和 API 穩定性 部分,以瞭解更多詳細資訊。

將 Kafka 端點新增至 MinIO 部署

以下程序會新增新的 Kafka 服務端點,以支援 MinIO 部署中的 bucket 通知

先決條件

Kafka 最低版本和支援版本

MinIO 依賴 https://github.com/Shopify/sarama 專案進行 Kafka 連線,並分享該專案的 Kafka 支援。請參閱 sarama 相容性和 API 穩定性 部分,以瞭解更多詳細資訊。

MinIO mc 命令列工具

此程序會針對某些動作使用 mc 命令列工具。請參閱 mc 快速入門 以取得安裝指示。

1) 將 Kafka 端點新增至 MinIO

您可以使用環境變數設定執行階段組態設定來設定新的 Kafka 服務端點。

MinIO 支援使用環境變數來指定 Kafka 服務端點和相關的設定。 minio server 程序會在下次啟動時套用指定的設定。

以下範例程式碼設定了與配置 Kafka 服務端點相關的所有環境變數。 最小必要的變數是 MINIO_NOTIFY_KAFKA_ENABLEMINIO_NOTIFY_KAFKA_BROKERS

set MINIO_NOTIFY_KAFKA_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_KAFKA_BROKERS_<IDENTIFIER>="<ENDPOINT>"
set MINIO_NOTIFY_KAFKA_TOPIC_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_SASL_USERNAME_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_SASL_PASSWORD_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_SASL_MECHANISM_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_TLS_CLIENT_AUTH_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_SASL_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_TLS_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_TLS_SKIP_VERIFY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_CLIENT_TLS_CERT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_CLIENT_TLS_KEY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_VERSION_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_KAFKA_COMMENT_<IDENTIFIER>="<string>"
  • <IDENTIFIER> 替換為 Kafka 服務端點的唯一描述性字串。 對於與新目標服務端點相關的所有環境變數,使用相同的 <IDENTIFIER> 值。 以下範例假設識別符號為 PRIMARY

    如果指定的 <IDENTIFIER> 與 MinIO 部署中現有的 Kafka 服務端點相符,則新設定會覆寫該端點的任何現有設定。 使用 mc admin config get notify_kafka 來檢閱 MinIO 部署上目前已設定的 Kafka 端點。

  • <ENDPOINT> 替換為以逗號分隔的 Kafka 代理程式清單。 例如

    "kafka1.example.com:2021,kafka2.example.com:2021"

請參閱儲存桶通知的 Kafka 服務,以取得每個環境變數的完整文件。

MinIO 支援使用 mc admin config set 命令和 notify_kafka 組態金鑰,在執行中的 minio server 程序上新增或更新 Kafka 端點。 您必須重新啟動 minio server 程序,以套用任何新的或更新的組態設定。

以下範例程式碼設定了與配置 Kafka 服務端點相關的所有設定。 最小必要的設定是 notify_kafka brokers

mc admin config set ALIAS/ notify_kafka:IDENTIFIER \
   brokers="<ENDPOINT>" \
   topic="<string>" \
   sasl_username="<string>" \
   sasl_password="<string>" \
   sasl_mechanism="<string>" \
   tls_client_auth="<string>" \
   tls="<string>" \
   tls_skip_verify="<string>" \
   client_tls_cert="<string>" \
   client_tls_key="<string>" \
   version="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"
  • IDENTIFIER 替換為 Kafka 服務端點的唯一描述性字串。 此程序中的以下範例假設識別符號為 PRIMARY

    如果指定的 IDENTIFIER 與 MinIO 部署中現有的 Kafka 服務端點相符,則新設定會覆寫該端點的任何現有設定。 使用 mc admin config get notify_kafka 來檢閱 MinIO 部署上目前已設定的 Kafka 端點。

  • ENDPOINT 替換為以逗號分隔的 Kafka 代理程式清單。 例如

    "kafka1.example.com:2021,kafka2.example.com:2021"

請參閱Kafka 儲存桶通知組態設定,以取得每個設定的完整文件。

2) 重新啟動 MinIO 部署

您必須重新啟動 MinIO 部署,才能套用組態變更。 使用 mc admin service restart 命令來重新啟動部署。

mc admin service restart ALIAS

ALIAS 替換為要重新啟動的部署的別名

minio server 程序會在啟動時針對每個已設定的 Kafka 目標印出一行,類似如下

SQS ARNs: arn:minio:sqs::primary:kafka

當您使用相關的 Kafka 部署作為目標來設定儲存桶通知時,必須指定 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:kafka

使用 jq 來剖析 JSON 以取得值

  1. 安裝 jq

  2. 複製並執行以下命令,將 ALIAS 替換為部署的別名

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

    這會傳回要用於通知的 ARN,例如 arn:minio:sqs::primary:kafka

3) 使用 Kafka 端點作為目標設定儲存桶通知

使用 mc event add 命令新增以已設定的 Kafka 服務作為目標的新儲存桶通知事件

mc event add ALIAS/BUCKET arn:minio:sqs::primary:kafka \
  --event EVENTS
  • ALIAS 替換為 MinIO 部署的別名

  • BUCKET 替換為要在其中設定事件的儲存桶名稱。

  • EVENTS 替換為以逗號分隔的 事件清單,MinIO 會針對這些事件觸發通知。

使用 mc event ls 來檢視指定通知目標的所有已設定儲存桶事件

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

4) 驗證已設定的事件

在您已設定新事件的儲存桶上執行動作,並檢查 Kafka 服務的通知資料。 所需的動作取決於設定儲存桶通知時指定的 事件

例如,如果儲存桶通知組態包含 s3:ObjectCreated:Put 事件,則可以使用 mc cp 命令在儲存桶中建立新物件,並觸發通知。

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

更新 MinIO 部署中的 Kafka 端點

以下程序會更新現有的 Kafka 服務端點,以支援 MinIO 部署中的儲存桶通知

必要條件

Kafka 最低版本和支援的版本

MinIO 依賴 https://github.com/Shopify/sarama 專案進行 Kafka 連線,並分享該專案的 Kafka 支援。請參閱 sarama 相容性和 API 穩定性 部分,以瞭解更多詳細資訊。

MinIO mc 命令列工具

此程序會針對某些動作使用 mc 命令列工具。請參閱 mc 快速入門 以取得安裝指示。

1) 列出部署中已設定的 Kafka 端點

使用 mc admin config get 命令列出部署中目前已設定的 Kafka 服務端點

mc admin config get ALIAS/ notify_kafka

ALIAS 替換為 MinIO 部署的別名

命令輸出類似如下

notify_kafka:primary tls_skip_verify="off"  queue_dir="" queue_limit="0" sasl="off" sasl_password="" sasl_username="" tls_client_auth="0" tls="off" brokers="" topic="" client_tls_cert="" client_tls_key="" version=""
notify_kafka:secondary tls_skip_verify="off"  queue_dir="" queue_limit="0" sasl="off" sasl_password="" sasl_username="" tls_client_auth="0" tls="off" brokers="" topic="" client_tls_cert="" client_tls_key="" version=""

notify_kafka 金鑰是 Kafka 通知設定的頂層組態金鑰。brokers 金鑰指定指定 notify_kafka 金鑰的 Kafka 服務端點。notify_kafka:<IDENTIFIER> 後綴描述該 Kafka 服務端點的唯一識別符號。

記下您要為下一個步驟更新的 Kafka 服務端點的識別符號。

2) 更新 Kafka 端點

使用 mc admin config set 命令來設定 Kafka 服務端點的新配置。

mc admin config set ALIAS/ notify_kafka:<IDENTIFIER> \
   brokers="https://kafka1.example.net:9200, https://kafka2.example.net:9200" \
   topic="<string>" \
   sasl_username="<string>" \
   sasl_password="<string>" \
   sasl_mechanism="<string>" \
   tls_client_auth="<string>" \
   tls="<string>" \
   tls_skip_verify="<string>" \
   client_tls_cert="<string>" \
   client_tls_key="<string>" \
   version="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"

notify_kafka brokers 配置設定是 Kafka 服務端點所需的最低要求。所有其他配置設定都是可選的。請參閱 Kafka 通知設定 以取得完整的 Kafka 配置設定列表。

3) 重新啟動 MinIO 部署

您必須重新啟動 MinIO 部署,才能套用組態變更。 使用 mc admin service restart 命令來重新啟動部署。

mc admin service restart ALIAS

ALIAS 替換為要重新啟動的部署的別名

minio server 程序會在啟動時針對每個已設定的 Kafka 目標印出一行,類似如下

SQS ARNs: arn:minio:sqs::primary:kafka

4) 驗證變更

針對使用更新後的 Kafka 服務端點,且具有事件配置的儲存桶執行操作,並檢查 Kafka 服務的通知資料。所需的操作取決於配置儲存桶通知時指定的 events

例如,如果儲存桶通知組態包含 s3:ObjectCreated:Put 事件,則可以使用 mc cp 命令在儲存桶中建立新物件,並觸發通知。

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