文件

發佈事件至 NSQ

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

將 NSQ 端點新增至 MinIO 部署

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

先決條件

MinIO mc 命令列工具

此程序使用 mc 命令列工具執行某些動作。請參閱 mc 快速入門,以取得安裝說明。

1) 將 NSQ 端點新增至 MinIO

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

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

以下範例程式碼設定與設定 NSQ 服務端點相關的所有環境變數。最少需要的變數是 MINIO_NOTIFY_NSQ_NSQD_ADDRESSMINIO_NOTIFY_NSQ_TOPIC

set MINIO_NOTIFY_NSQ_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_NSQ_NSQD_ADDRESS_<IDENTIFIER>="<ENDPOINT>"
set MINIO_NOTIFY_NSQ_TOPIC_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NSQ_TLS_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NSQ_TLS_SKIP_VERIFY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NSQ_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NSQ_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_NSQ_COMMENT_<IDENTIFIER>="<string>"
  • <IDENTIFIER> 取代為目標服務端點的唯一描述性字串。針對與新目標服務端點相關的所有環境變數,使用相同的 <IDENTIFIER> 值。以下範例假設識別碼為 PRIMARY

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

  • <ENDPOINT> 取代為 NSQ 服務端點的 URL。例如,https://nsq-service.example.com:4150

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

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

以下範例程式碼設定與設定 NSQ 服務端點相關的所有設定。最少需要設定的為 notify_nsq nsqd_addressnotify_nsq topic

mc admin config set ALIAS/ notify_nsq:IDENTIFIER \
  nsqd_address="ENDPOINT" \
  topic="<string>" \
  tls="<string>" \
  tls_skip_verify="<string>" \
  queue_dir="<string>" \
  queue_limit="<string>" \
  comment="<string>"
  • IDENTIFIER 取代為 NSQ 服務端點的唯一描述性字串。此程序中的以下範例假設識別碼為 PRIMARY

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

  • ENDPOINT 取代為 NSQ 服務端點的 URL。例如

    NSQ://user:password@hostname:port

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

2) 重新啟動 MinIO 部署

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

mc admin service restart ALIAS

ALIAS 取代為要重新啟動的部署的 別名

在啟動時,minio server 程序會針對每個已設定的 NSQ 目標列印一行,類似以下內容

SQS ARNs: |ARN|

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

使用 jq 來剖析 JSON 以取得值

  1. 安裝 jq

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

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

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

3) 使用 NSQ 端點作為目標來設定儲存貯體通知

使用 mc event add 命令來新增一個新的儲存貯體通知事件,並以設定的 NSQ 服務作為目標

mc event add ALIAS/BUCKET arn:minio:sqs::primary:nsq \
  --event EVENTS
  • ALIAS 取代為 MinIO 部署的 別名

  • BUCKET 取代為要設定事件的儲存貯體名稱。

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

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

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

4) 驗證設定的事件

對您為其設定新事件的儲存貯體執行動作,並檢查 NSQ 服務中的通知資料。所需的動作取決於設定儲存貯體通知時指定的 events

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

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

在 MinIO 部署中更新 NSQ 端點

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

先決條件

MinIO mc 命令列工具

此程序使用 mc 命令列工具執行某些動作。請參閱 mc 快速入門,以取得安裝說明。

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

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

mc admin config get ALIAS/ notify_nsq

ALIAS 取代為 MinIO 部署的 別名

命令輸出類似以下內容

notify_nsq:primary nsqd_address="https://nsq.example.com" queue_dir="" queue_limit="0"  tls="off" tls_skip_verify="off" topic=""
notify_nsq:secondary nsqd_address="https://nsq.example.com" queue_dir="" queue_limit="0"  tls="off" tls_skip_verify="off" topic=""

notify_nsq 鍵是 NSQ 通知設定 的最上層組態鍵。nsqd_address 鍵指定給定 notify_nsq 鍵的 NSQ 服務端點。notify_nsq:<IDENTIFIER> 後綴描述該 NSQ 服務端點的唯一識別碼。

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

2) 更新 NSQ 端點

使用 mc admin config set 命令來設定 NSQ 服務端點的新組態

mc admin config set ALIAS/ notify_nsq:<IDENTIFIER> \
   nsqd_address="NSQ://user:password@hostname:port" \
   topic="<string>" \
   tls="<string>" \
   tls_skip_verify="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"

notify_nsq nsqd_address 組態設定是 NSQ 服務端點的最低要求。所有其他組態設定都是選用的。請參閱 NSQ 通知設定 以取得完整的 NSQ 組態設定清單。

3) 重新啟動 MinIO 部署

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

mc admin service restart ALIAS

ALIAS 取代為要重新啟動的部署的 別名

在啟動時,minio server 程序會針對每個已設定的 NSQ 目標列印一行,類似以下內容

SQS ARNs: arn:minio:sqs::primary:NSQ

4) 驗證變更

對使用已更新 NSQ 服務端點的事件組態的儲存桶執行操作,並檢查 NSQ 服務中的通知數據。所需的操作取決於配置儲存桶通知時指定的 events

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

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