文件

發佈事件至 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>取代為 TARGET 服務端點的唯一描述性字串。針對與新目標服務端點相關的所有環境變數使用相同的<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 服務中的通知資料。所需的動作取決於設定儲存桶通知時指定的 事件

例如,如果儲存桶通知組態包含 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