Redis Notification Settings

This page documents settings for configuring a Redis service as a target for Bucket Notifications. See Publish Events to Redis 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.

Multiple Redis targets

Redis multi-targets

export MINIO_NOTIFY_REDIS_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_REDIS_ADDRESS_PRIMARY="redis-endpoint.example.net:9200"
export MINIO_NOTIFY_REDIS_KEY_PRIMARY="bucketevents"
export MINIO_NOTIFY_REDIS_FORMAT_PRIMARY="namespace"

export MINIO_NOTIFY_REDIS_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_REDIS_ADDRESS_SECONDARY="redis-endpoint2.example.net:9200"
export MINIO_NOTIFY_REDIS_KEY_SECONDARY="bucketevents"
export MINIO_NOTIFY_REDIS_FORMAT_SECONDARY="namespace"

mc admin config set ALIAS notify_redis:primary              \
   address="redis-endpoint.example.net:9200"  \
   key="bucketevents"                                 \
   format="namespace"                                 \
   [ARGUMENT="VALUE"] ...

mc admin config set ALIAS notify_redis:secondary            \
   address="redis-endpoint2.example.net:9200" \
   key="bucketevents"                                 \
   format="namespace"                                 \
   [ARGUMENT="VALUE"] ...

Settings

REDIS ENABLE

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_ADDRESS
MINIO_NOTIFY_REDIS_KEY
MINIO_NOTIFY_REDIS_FORMAT

notify_redis

The top-level configuration key for defining an Redis server/broker endpoint for use with MinIO AIStor bucket notifications.

Use mc admin config set to set or update an Redis server/broker endpoint. The following arguments are required for each endpoint:

address
key
format

Specify additional optional arguments as a whitespace (" ")-delimited list.

mc admin config set ALIAS notify_redis \
   address="ENDPOINT" \
   key="<string>" \
   format="<string>" \
   [ARGUMENT="VALUE"] ...

Address

MINIO_NOTIFY_REDIS_ADDRESS

notify_redis address

Specify the Redis server address to which MinIO AIStor publishes bucket events.

Key

MINIO_NOTIFY_REDIS_KEY

notify_redis key

Specify the key to which MinIO AIStor publishes events in the Redis service.

Format

MINIO_NOTIFY_REDIS_FORMAT

notify_redis format

Specify the format of event data written to the Redis service endpoint.

Queue dir

MINIO_NOTIFY_REDIS_QUEUE_DIR

notify_redis 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 Redis server/broker is offline and replays the stored events when connectivity resumes.