文件

發佈事件至 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

請參閱 用於儲存桶通知的 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

當先前建立端點時,您定義了 <IDENTIFIER> 以指派給儲存桶通知的目標 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 端點設定為目標來設定儲存桶通知

使用 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"

請注意您想要在下一步更新的 NATS 服務端點的識別碼。

2) 更新 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>"

3) 重新啟動 MinIO 部署

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

mc admin service restart ALIAS

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

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

SQS ARNs: arn:minio:sqs::primary:nats

4) 驗證變更

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

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