eb94513104
- Creates a slew of folders and pages nested under the mc-server page to store settings. - Breaks up all of the environment variable options formerly in the mc-server page into these separate pages. - Moves the config settings formerly in the mc admin config page to the appropriate new settings pages. - Adds a MiniO Client settings page and document `mc-host-<alias>` Closes #1017
7.3 KiB
Redis Notification Settings
minio
Table of Contents
This page documents settings for configuring a Redis service as a
target for Bucket Notifications <minio-bucket-notifications>.
See minio-bucket-notifications-publish-redis for a
tutorial on using these settings.
Multiple Redis Targets
You can specify multiple Redis service endpoints by appending a
unique identifier _ID to the end of the top level key for
each set of related Redis settings. For example, the following commands
set two distinct Redis service endpoints as PRIMARY and
SECONDARY respectively:
Environment Variables
set MINIO_NOTIFY_REDIS_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_REDIS_REDIS_ADDRESS_PRIMARY="https://user:password@redis-endpoint.example.net:9200"
set MINIO_NOTIFY_REDIS_KEY_PRIMARY="bucketevents"
set MINIO_NOTIFY_REDIS_FORMAT_PRIMARY="namespace"
set MINIO_NOTIFY_REDIS_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_REDIS_REDIS_ADDRESS_SECONDARY="https://user:password@redis-endpoint2.example.net:9200"
set MINIO_NOTIFY_REDIS_KEY_SECONDARY="bucketevents"
set MINIO_NOTIFY_REDIS_FORMAT_SECONDARY="namespace"Configuration Settings
mc admin config set notify_redis:primary \
address="https://redis-endpoint.example.net:9200" \
key="bucketevents" \
format="namespace" \
[ARGUMENT="VALUE"] ... \
mc admin config set notify_redis:secondary \
address="https://redis-endpoint2.example.net:9200" \
key="bucketevents" \
format="namespace" \
[ARGUMENT="VALUE"] ... Settings
Enable
Required
Environment Variable
MINIO_NOTIFY_REDIS_ENABLE
Specify on to enable publishing bucket notifications to
a Redis service endpoint.
Defaults to off.
Requires specifying the following additional environment variables if
set to on:
MINIO_NOTIFY_REDIS_ADDRESSMINIO_NOTIFY_REDIS_KEYMINIO_NOTIFY_REDIS_FORMAT
Configuration Setting
notify_redis
The top-level configuration key for defining an Redis server/broker
endpoint for use with MinIO bucket notifications <minio-bucket-notifications>.
Use mc admin config set to set or update an Redis
server/broker endpoint. The following arguments are required
for each endpoint:
~notify_redis.address~notify_redis.key~notify_redis.format
Specify additional optional arguments as a whitespace
(" ")-delimited list.
mc admin config set notify_redis \
address="ENDPOINT" \
key="<string>" \
format="<string>" \
[ARGUMENT="VALUE"] ... \Address
Required
Environment Variable
MINIO_NOTIFY_REDIS_ADDRESS
Configuration Setting
notify_redis address
Specify the Redis service endpoint to which MinIO publishes bucket
events. For example, https://redis.example.com:6369.
Key
Required
Environment Variable
MINIO_NOTIFY_REDIS_KEY
Configuration Setting
notify_redis key
Specify the Redis key to use for storing and updating events. Redis auto-creates the key if it does not exist.
Format
Required
Environment Variable
MINIO_NOTIFY_REDIS_FORMAT
Configuration Setting
notify_redis format
Specify the format of event data written to the Redis service endpoint. MinIO supports the following values:
namespace-
For each bucket event, MinIO creates a JSON document with the bucket and object name from the event as the document ID and the actual event as part of the document body. Additional updates to that object modify the existing index entry for that object. Similarly, deleting the object also deletes the corresponding index entry.
access-
For each bucket event, MinIO creates a JSON document with the event details and appends it to the key with a Redis-generated random ID. Additional updates to an object result in new index entries, and existing entries remain unmodified.
Password
Optional
Environment Variable
MINIO_NOTIFY_REDIS_PASSWORD
Configuration Setting
notify_redis password
Specify the password for the Redis server.
RELEASE.2023-06-23T20-26-00Z
MinIO redacts this value when returned as part of mc admin config get.
Queue Directory
Optional
Environment Variable
MINIO_NOTIFY_REDIS_QUEUE_DIR
Configuration Setting
notify_redis 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 Redis server/broker is offline and replays the stored events when connectivity resumes.
Queue Limit
Optional
Environment Variable
MINIO_NOTIFY_REDIS_QUEUE_LIMIT
Configuration Setting
notify_redis queue_limit
Specify the maximum limit for undelivered messages. Defaults to
100000.
Comment
Optional
Environment Variable
MINIO_NOTIFY_REDIS_COMMENT
Configuration Setting
notify_redis comment
Specify a comment to associate with the Redis configuration.