4edb3f7bae
# Summary As per a recent customer issue, our guidance on `MINIO_DOMAIN` and path/virtual bucket lookups needs some attention. There are two main areas to address: 1. We need to guide users to avoid namespace collision within the `MINIO_DOMAIN` , as this causes bucket lookup issues with certain MinIO services/features 2. We need to generally improve docs on setting `MINIO_DOMAIN` correctly There is also a side objective from Engineering to ensure we have a simple admonition to direct users to test wherever possible changes to config settings before applying to production. --------- Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
6.1 KiB
NSQ Notification Settings
minio
Table of Contents
This page documents settings for configuring an NSQ service as a
target for Bucket Notifications <minio-bucket-notifications>.
See minio-bucket-notifications-publish-nsq for a tutorial
on using these settings.
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:
Environment Variables
set MINIO_NOTIFY_NSQ_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_NSQ_NSQD_ADDRESS_PRIMARY="https://user:password@nsq-endpoint.example.net:9200"
set MINIO_NOTIFY_NSQ_TOPIC_PRIMARY="bucketevents"
set MINIO_NOTIFY_NSQ_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_NSQ_NSQD_ADDRESS_SECONDARY="https://user:password@nsq-endpoint.example.net:9200"
set MINIO_NOTIFY_NSQ_TOPIC_SECONDARY="bucketevents"Configuration Settings
mc admin config set notify_nsq:primary \
nsqd_address="ENDPOINT" \
topic="<string>" \
[ARGUMENT="VALUE"] ... \
mc admin config set notify_nsq:secondary \
nsqd_address="ENDPOINT" \
topic="<string>" \
[ARGUMENT="VALUE"] ... \Settings
Enable
Required
Environment Variable
MINIO_NOTIFY_NSQ_ENABLE
Specify on to enable publishing bucket notifications to
an NSQ endpoint.
Configuration Setting
notify_nsq
The top-level configuration key for defining an NSQ server/broker
endpoint for use with MinIO bucket notifications <minio-bucket-notifications>.
Use mc admin config set to set or update an NSQ
server/broker endpoint. The following arguments are required
for each endpoint:
~notify_nsq.nsqd_address~notify_nsq.topic
Specify additional optional arguments as a whitespace
(" ")-delimited list.
mc admin config set notify_nsq \
nsqd_address="https://nsq-endpoint.example.net:4150" \
topic="<string>" \
[ARGUMENT="VALUE"] ...NSQ Daemon Server Address
Required
Environment Variable
MINIO_NOTIFY_NSQ_NSQD_ADDRESS
Configuration Setting
notify_nsq nsqd_address
Specify the NSQ server address where the NSQ Daemon runs. For example:
https://nsq-endpoint.example.net:4150
Topic
Required
Environment Variable
MINIO_NOTIFY_NSQ_TOPIC
Configuration Setting
notify_nsq topic
Specify the name of the NSQ topic MinIO uses when publishing events to the broker.
TLS
Optional
Environment Variable
MINIO_NOTIFY_NSQ_TLS
Configuration Setting
notify_nsq tls
Specify on to enable TLS connectivity to the NSQ service
broker.
TLS Skip Verify
Optional
Environment Variable
MINIO_NOTIFY_NSQ_TLS_SKIP_VERIFY
Configuration Setting
notify_nsq 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 Directory
Optional
Environment Variable
MINIO_NOTIFY_NSQ_QUEUE_DIR
Configuration Setting
notify_nsq queue_dir
Specify the directory path to enable MinIO's persistent event store
for undelivered messages, such as /opt/minio/events.
MinIO 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
Environment Variable
MINIO_NOTIFY_NSQ_QUEUE_LIMIT
Configuration Setting
notify_nsq queue_limit
Specify the maximum limit for undelivered messages. Defaults to
100000.
Comment
Optional
Environment Variable
MINIO_NOTIFY_NSQ_COMMENT
Configuration Setting
notify_nsq comment
Specify a comment to associate with the NSQ configuration.