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 AIStor Server. Refer to your operating system’s documentation for how to define an environment variable.
- a configuration setting using
mc admin config set.
If you define both an environment variable and the similar configuration setting, MinIO AIStor uses the environment variable value.
Some settings have only an environment variable or a configuration setting, but not both.
Each configuration setting controls fundamental MinIO AIStor behavior and functionality. Test configuration changes in a lower environment, such as DEV or QA, before applying to production.
You can specify multiple targets by appending a unique identifier _ID for each set of related settings.
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"You can specify multiple targets by appending a unique identifier :ID to the configuration key.
mc admin config set ALIAS notify_nsq:primary \
nsqd_address="ENDPOINT" \
topic="<string>" \
[ARGUMENT="VALUE"] ...
mc admin config set ALIAS notify_nsq:secondary \
nsqd_address="ENDPOINT" \
topic="<string>" \
[ARGUMENT="VALUE"] ...Settings
Enable
Specify on to enable publishing bucket notifications to an NSQ service endpoint.
Defaults to off.
The top-level configuration key for defining an NSQ server/broker endpoint for use with MinIO AIStor bucket notifications.
Use mc 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.
mc admin config set ALIAS notify_nsq \
nsqd_address="https://nsq-endpoint.example.net:4150" \
topic="<string>" \
[ARGUMENT="VALUE"] ...NSQD address
Specify the NSQ Daemon server address to which MinIO AIStor publishes bucket events.
Topic
Specify the topic to which MinIO AIStor publishes events in the NSQ service.
TLS
Specify on to enable TLS connectivity to the NSQ service broker.
TLS skip verify
Enables or disables TLS verification of the NSQ service broker TLS certificates.
- Specify
onto disable TLS verification (Default). - Specify
offto enable TLS verification.
Queue dir
Specify the directory path to enable MinIO’s persistent event store for undelivered messages, such as /opt/minio/events.
MinIO AIStor stores undelivered events in the specified store while the NSQ server/broker is offline and replays the stored events when connectivity resumes.
Queue limit
Specify the maximum limit for undelivered messages. Defaults to 100000.
Comment
Specify a comment to associate with the NSQ configuration.