文件

發佈事件至 NATS

MinIO 支援將儲存桶通知事件發佈至NATS服務端點。

NATS Streaming 已淘汰

NATS Streaming 已淘汰。請改為移轉至JetStream

相關的 MinIO 設定選項和環境變數已淘汰。

將 NATS 端點新增至 MinIO 部署

以下程序會新增新的 NATS 服務端點,以支援 MinIO 部署中的儲存桶通知

先決條件

MinIO mc 命令列工具

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

1) 將 NATS 端點新增至 MinIO

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

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

以下範例程式碼設定與組態 NATS 服務端點相關的所有環境變數。最少必要變數為MINIO_NOTIFY_NATS_ADDRESSMINIO_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

請參閱 用於 Bucket 通知的 NATS 服務 以取得每個環境變數的完整文件。

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

以下範例程式碼設定與組態 NATS 服務端點相關的所有設定。必要的最小設定是 notify_nats addressnotify_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 Bucket 通知組態設定 以取得每個設定的完整文件。

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

識別 Bucket 通知的 ARN

您在先前建立端點時定義了 <IDENTIFIER>,以便將其指派給 Bucket 通知的目標 ARN。下列步驟會傳回部署上組態的 ARN。尋找您指定的 <IDENTIFIER>,藉此識別先前建立的 ARN。

檢閱 JSON 輸出

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

    mc admin info --json ALIAS
    
  2. 在 JSON 輸出中,尋找金鑰 info.sqsARN

    您需要的 ARN 是符合您指定之 <IDENTIFIER> 的金鑰值。

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

使用 jq 來剖析 JSON 以取得值

  1. 安裝 jq

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

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

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

3) 使用 NATS 端點作為目標組態 Bucket 通知

使用 mc event add 命令,以已組態的 NATS 服務為目標新增新的 Bucket 通知事件

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

  • BUCKET 替換為要組態事件的 Bucket 名稱。

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

使用 mc event ls 以檢視給定通知目標的所有已組態的 Bucket 事件

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

4) 驗證已組態的事件

針對您組態新事件的 Bucket 執行動作,並檢查 NATS 服務是否有通知資料。所需的動作取決於組態 Bucket 通知時指定的 events

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

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

在 MinIO 部署中更新 NATS 端點

以下程序會更新現有的 NATS 服務端點,以支援 MinIO 部署中的 Bucket 通知

先決條件

MinIO mc 命令列工具

此程序針對特定動作使用mc命令列工具。請參閱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

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

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