Table of Contents
MinIO supports publishing bucket notification events to a Redis service endpoint.
The following procedure adds a new Redis service endpoint for supporting bucket notifications in a MinIO deployment.
mc
Command Line ToolThis procedure uses the mc
command line tool for certain actions.
See the mc
Quickstart for installation instructions.
You can configure a new Redis service endpoint using either environment variables or by setting runtime configuration settings.
MinIO supports specifying the Redis service endpoint and associated
configuration settings using
environment variables. The
minio server
process applies the specified settings on its
next startup.
The following example code sets all environment variables related to configuring an Redis service endpoint. The minimum required variables are:
set MINIO_NOTIFY_REDIS_ENABLE_<IDENTIFIER>="on"
set MINIO_NOTIFY_REDIS_ADDRESS_<IDENTIFIER>="<ENDPOINT>"
set MINIO_NOTIFY_REDIS_KEY_<IDENTIFIER>="<STRING>"
set MINIO_NOTIFY_REDIS_FORMAT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_REDIS_PASSWORD_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_REDIS_QUEUE_DIR_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_REDIS_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_REDIS_COMMENT_<IDENTIFIER>="<string>"
Replace <IDENTIFIER>
with a unique descriptive string for the
TARGET service endpoint. Use the same <IDENTIFIER>
value for all
environment variables related to the new target service endpoint.
The following examples assume an identifier of PRIMARY
.
If the specified <IDENTIFIER>
matches an existing Redis service
endpoint on the MinIO deployment, the new settings override
any existing settings for that endpoint. Use
mc admin config get notify_redis
to
review the currently configured Redis endpoints on the MinIO deployment.
Replace <ENDPOINT>
with the URL of the Redis service endpoint.
For example: https://redis.example.com:6369
See Redis Service for Bucket Notifications for complete documentation on each environment variable.
MinIO supports adding or updating Redis endpoints on a running
minio server
process using the mc admin config set
command
and the notify_redis
configuration key. You must restart the
minio server
process to apply any new or updated configuration
settings.
The following example code sets all settings related to configuring an Redis service endpoint. The minimum required settings are:
mc admin config set ALIAS/ notify_redis:IDENTIFIER \
address="ENDPOINT" \
key="<string>" \
format="<string>" \
password="<string>" \
queue_dir="<string>" \
queue_limit="<string>" \
comment="<string>"
Replace IDENTIFIER
with a unique descriptive string for the
Redis service endpoint. The following examples in this procedure
assume an identifier of PRIMARY
.
If the specified IDENTIFIER
matches an existing Redis service
endpoint on the MinIO deployment, the new settings override
any existing settings for that endpoint. Use
mc admin config get notify_redis
to
review the currently configured Redis endpoints on the MinIO deployment.
Replace ENDPOINT
with the URL of the Redis service endpoint.
For example: https://redis.example.com:6369
See Redis Bucket Notification Configuration Settings for complete documentation on each setting.
You must restart the MinIO deployment to apply the configuration changes.
Use the mc admin service restart
command to restart the deployment.
mc admin service restart ALIAS
Replace ALIAS
with the alias of the deployment to
restart.
The minio server
process prints a line on startup for each configured Redis
target similar to the following:
SQS ARNs: arn:minio:sqs::primary:redis
You must specify the ARN resource when configuring bucket notifications with the associated Redis deployment as a target.
Identifying the ARN for your bucket notifications
You defined the <IDENTIFIER>
to assign to the target ARN for your bucket notifications when creating the endpoint previously.
The steps below return the ARNs configured on the deployment.
Identify the ARN created previously by looking for the <IDENTIFIER>
you specified.
Review the JSON output
Copy and run the following command, replacing ALIAS
with the alias of the deployment.
mc admin info --json ALIAS
In the JSON output, look for the key info.sqsARN
.
The ARN you need is the value of that key that matches the <IDENTIFIER>
you specified.
For example, arn:minio:sqs::primary:redis
.
Use jq to parse the JSON for the value
Copy and run the following command, replacing ALIAS
with the alias of the deployment.
mc admin info --json ALIAS | jq .info.sqsARN
This returns the ARN to use for notifications, such as arn:minio:sqs::primary:redis
Use the mc event add
command to add a new bucket notification
event with the configured Redis service as a target:
mc event add ALIAS/BUCKET arn:minio:sqs::primary:redis \
--event EVENTS
Replace ALIAS
with the alias of a MinIO deployment.
Replace BUCKET
with the name of the bucket in which to configure the
event.
Replace EVENTS
with a comma-separated list of events for which MinIO triggers notifications.
Use mc event list
to view all configured bucket events for
a given notification target:
mc event list ALIAS/BUCKET arn:minio:sqs::primary:redis
Perform an action on the bucket for which you configured the new event and
check the Redis service for the notification data. The action required
depends on which events
were specified
when configuring the bucket notification.
For example, if the bucket notification configuration includes the
s3:ObjectCreated:Put
event, you can use the
mc cp
command to create a new object in the bucket and trigger
a notification.
mc cp ~/data/new-object.txt ALIAS/BUCKET
The following procedure updates an existing Redis service endpoint for supporting bucket notifications in a MinIO deployment.
mc
Command Line ToolThis procedure uses the mc
command line tool for certain actions.
See the mc
Quickstart for installation instructions.
Use the mc admin config get
command to list the currently
configured Redis service endpoints in the deployment:
mc admin config get ALIAS/ notify_redis
Replace ALIAS
with the alias of the MinIO deployment.
The command output resembles the following:
notify_redis:primary address="https://redis.example.com:6369" format="namespace" key="minioevent" password="" queue_dir="" queue_limit="0"
notify_redis:secondary address="https://redis.example.com:6369" format="namespace" key="minioevent" password="" queue_dir="" queue_limit="0"
The notify_redis
key is the top-level configuration key for an
Redis Service for Bucket Notifications. The
address
key specifies the Redis service endpoint
for the given notify_redis key. The notify_redis:<IDENTIFIER>
suffix
describes the unique identifier for that Redis service endpoint.
Note the identifier for the Redis service endpoint you want to update for the next step.
Use the mc admin config set
command to set the new configuration
for the Redis service endpoint:
mc admin config set ALIAS/ notify_redis:IDENTIFIER \
address="ENDPOINT" \
key="<string>" \
format="<string>" \
password="<string>" \
queue_dir="<string>" \
queue_limit="<string>" \
comment="<string>"
The notify_redis address
configuration setting
is the minimum required for an Redis service endpoint. All other configuration
settings are optional. See
Redis Service for Bucket Notifications for a complete list of
Redis configuration settings.
You must restart the MinIO deployment to apply the configuration changes.
Use the mc admin service restart
command to restart the deployment.
mc admin service restart ALIAS
Replace ALIAS
with the alias of the deployment to
restart.
The minio server
process prints a line on startup for each configured Redis
target similar to the following:
SQS ARNs: arn:minio:sqs::primary:redis
Perform an action on a bucket which has an event configuration using the updated
Redis service endpoint and check the Redis service for the notification data. The
action required depends on which events
were
specified when configuring the bucket notification.
For example, if the bucket notification configuration includes the
s3:ObjectCreated:Put
event, you can use the
mc cp
command to create a new object in the bucket and trigger
a notification.
mc cp ~/data/new-object.txt ALIAS/BUCKET
This work is licensed under a Creative Commons Attribution 4.0 International License.
©2020-Present, MinIO, Inc.