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, 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 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

Environment Variables

export MINIO_NOTIFY_REDIS_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_REDIS_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_REDIS_ADDRESS_SECONDARY="redis-endpoint2.example.net:9200"
export MINIO_NOTIFY_REDIS_KEY_SECONDARY="bucketevents"
export MINIO_NOTIFY_REDIS_FORMAT_SECONDARY="namespace"

Configuration Settings

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

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

Settings

REDIS ENABLE

Environment Variable Configuration Setting

notify_redis

The top-level configuration key for defining an Redis server/broker endpoint for use with 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 notify_redis \
   address="ENDPOINT" \
   key="<string>" \
   format="<string>" \
   [ARGUMENT="VALUE"] ... \

Address

Environment Variable Configuration Setting

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

Key

Environment Variable Configuration Setting

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

Format

Environment Variable Configuration Setting

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

Queue dir

Environment Variable Configuration Setting

Specify the directory path to enable MinIO’s persistent event store for undelivered messages, such as /opt/minio/events.

AIStor stores undelivered events in the specified store while the Redis server/broker is offline and replays the stored events when connectivity resumes.

Queue limit

Environment Variable Configuration Setting

Specify the maximum limit for undelivered messages. Defaults to 100000.

Comment

Environment Variable Configuration Setting

Specify a comment to associate with the Redis configuration.

Password

Environment Variable Configuration Setting

Specify the password for the Redis server.

AIStor redacts this value when returned as part of mc admin config get.

User

Environment Variable Configuration Setting

Specify the user for the Redis server.