NSQ Notification Settings
This page documents settings for configuring an NSQ service as a target for Bucket Notifications. See Publish Events to NSQ for a tutorial on using these settings.
You can establish or modify settings by defining:
an environment variable on the host system prior to starting or restarting the Buckit Server. Refer to your operating system’s documentation for how to define an environment variable.
a configuration setting using
bm admin config set.
If you define both an environment variable and the similar configuration setting, Buckit uses the environment variable value.
Some settings have only an environment variable or a configuration setting, but not both.
Important
Each configuration setting controls fundamental Buckit behavior and functionality. Buckit strongly recommends testing configuration changes in a lower environment, such as DEV or QA, before applying to production.
Multiple NSQ Targets
You can specify multiple NSQ service endpoints by appending a unique identifier _ID to the end of the top level key for each set of related NSQ settings.
For example, the following commands set two distinct NSQ service endpoints as PRIMARY and SECONDARY respectively:
export MINIO_NOTIFY_NSQ_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_NSQ_NSQD_ADDRESS_PRIMARY="https://user:password@nsq-endpoint.example.net:9200"
export MINIO_NOTIFY_NSQ_TOPIC_PRIMARY="bucketevents"
export MINIO_NOTIFY_NSQ_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_NSQ_NSQD_ADDRESS_SECONDARY="https://user:password@nsq-endpoint.example.net:9200"
export MINIO_NOTIFY_NSQ_TOPIC_SECONDARY="bucketevents"
bm admin config set notify_nsq:primary \
nsqd_address="ENDPOINT" \
topic="<string>" \
[ARGUMENT="VALUE"] ... \
bm admin config set notify_nsq:secondary \
nsqd_address="ENDPOINT" \
topic="<string>" \
[ARGUMENT="VALUE"] ... \
Settings
Enable
Required
The top-level configuration key for defining an NSQ server/broker endpoint for use with Buckit bucket notifications.
Use bm admin config set to set or update an NSQ server/broker endpoint.
The following arguments are required for each endpoint:
Specify additional optional arguments as a whitespace (" ")-delimited list.
bm admin config set notify_nsq \
nsqd_address="https://nsq-endpoint.example.net:4150" \
topic="<string>" \
[ARGUMENT="VALUE"] ...
NSQ Daemon Server Address
Required
Specify the NSQ server address where the NSQ Daemon runs. For example:
https://nsq-endpoint.example.net:4150
Topic
Required
Specify the name of the NSQ topic Buckit uses when publishing events to the broker.
TLS
Optional
Specify on to enable TLS connectivity to the NSQ service broker.
TLS Skip Verify
Optional
Enables or disables TLS verification of the NSQ service broker TLS certificates.
Specify
onto disable TLS verification (Default).Specify
offto enable TLS verification.
Queue Directory
Optional
Specify the directory path to enable Buckit’s persistent event store for undelivered messages, such as /opt/minio/events.
Buckit stores undelivered events in the specified store while the NSQ server/broker is offline and replays the stored events when connectivity resumes.
Queue Limit
Optional
Specify the maximum limit for undelivered messages.
Defaults to 100000.
Comment
Optional
Specify a comment to associate with the NSQ configuration.
