文件

發佈事件至 NATS

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

NATS Streaming 已棄用

NATS Streaming 已棄用。請改為移轉至 JetStream

相關的 MinIO 配置選項和環境變數已棄用。

將 NATS 端點新增至 MinIO 部署

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

先決條件

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

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

MinIO 支援使用 mc admin config set 命令和 notify_nats 組態金鑰,在執行的 minio server 程序上新增或更新 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 儲存桶通知組態設定,以取得每個設定的完整文件。

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 輸出

  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 端點作為目標來設定儲存桶通知

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

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

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

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

使用 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 命令列工具

此程序使用 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

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

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