Publish Events to AMQP (RabbitMQ)

AIStor supports publishing bucket notification events to a AMQP 0-9-1 service endpoint such as RabbitMQ.

• AMQP 0-9-1 service endpoint.

  AIStor relies on the https://github.com/streadway/amqp project for AMQP connectivity. The project is primarily tested against RabbitMQ deployments, though other AMQP 0-9-1-compatible services may also work. This procedure assumes a RabbitMQ deployment using the 0-9-1 protocol as the service endpoint.

  If the AMQP service requires authentication, you must provide an appropriate username and password during the configuration process to grant AIStor access to the service.

• The AIStor mc command line tool.

  This procedure uses the mc command line tool for certain actions. See the mc Quickstart for installation instructions.

The following procedure adds a new AMQP service endpoint for supporting bucket notifications for an AIStor Server.

1. Add the AMQP endpoint to AIStor.

   You can configure a new AMQP service endpoint using either environment variables or by setting runtime configuration settings.

   Environment Variables

   AIStor supports specifying the AMQP 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 AMQP service endpoint. The minimum required variables are MINIO_NOTIFY_AMQP_ENABLE and MINIO_NOTIFY_AMQP_URL:

   export MINIO_NOTIFY_AMQP_ENABLE_<IDENTIFIER>="on"
   export MINIO_NOTIFY_AMQP_URL_<IDENTIFIER>="<ENDPOINT>"
   export MINIO_NOTIFY_AMQP_EXCHANGE_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_EXCHANGE_TYPE_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_ROUTING_KEY_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_MANDATORY_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_DURABLE_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_NO_WAIT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_INTERNAL_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_AUTO_DELETED_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_DELIVERY_MODE_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_QUEUE_DIR_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_QUEUE_LIMIT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_AMQP_COMMENT_<IDENTIFIER>="<string>"
   

   • Replace <IDENTIFIER> with a unique descriptive string for the AMQP service endpoint. Use the same <IDENTIFIER> value for all environment variables related to the new AMQP service endpoint. The following examples assume an identifier of PRIMARY.

     If the specified <IDENTIFIER> matches an existing AMQP service endpoint on the AIStor Server, the new settings override any existing settings for that endpoint. Use mc admin config get notify_amqp to review the currently configured AMQP endpoints on the AIStor Server.

   • Replace <ENDPOINT> with the URL of the AMQP service endpoint. For example:

     amqp://user:password@hostname:port

   See AMQP Service for Bucket Notifications for complete documentation on each environment variable.

   Configuration Settings

   MinIO supports adding or updating AMQP endpoints on a running minio server process using the mc admin config set command and the notify_amqp 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 AMQP service endpoint. The minimum required setting is notify_amqp url:

   mc admin config set ALIAS/ notify_amqp:IDENTIFIER \
     url="ENDPOINT" \
     exchange="<string>" \
     exchange_type="<string>" \
     routing_key="<string>" \
     mandatory="<string>" \
     durable="<string>" \
     no_wait="<string>" \
     internal="<string>" \
     auto_deleted="<string>" \
     delivery_mode="<string>" \
     queue_dir="<string>" \
     queue_limit="<string>" \
     comment="<string>"
   

   • Replace IDENTIFIER with a unique descriptive string for the AMQP service endpoint. The following examples in this procedure assume an identifier of PRIMARY.

     If the specified IDENTIFIER matches an existing AMQP service endpoint on the AIStor Server, the new settings override any existing settings for that endpoint. Use mc admin config get notify_amqp to review the currently configured AMQP endpoints on the AIStor Server.

   • Replace ENDPOINT with the URL of the AMQP service endpoint. For example:

     amqp://user:password@hostname:port

   See AMQP Bucket Notification Configuration Settings for complete documentation on each setting.

   If you define both environment variables and configuration settings for the deployment, the settings defined by environment variables are used.

2. Restart the AIStor Server.

   You must restart the AIStor Server 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 AMQP target similar to the following:

   SQS ARNs: arn:minio:sqs::primary:amqp
   

   You must specify the ARN resource when configuring bucket notifications with the associated AMQP deployment as a target.

3. Configure bucket notifications using the AMQP endpoint as a target.

   Use the mc event add command to add a new bucket notification event with the configured AMQP service as a target:

   mc event add ALIAS/BUCKET arn:minio:sqs::primary:amqp \
     --event EVENTS
   

   • Replace ALIAS with the alias of an AIStor Server.
   • 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 AIStor triggers notifications.

   Use mc event ls to view all configured bucket events for a given notification target:

   mc event ls ALIAS/BUCKET arn:minio:sqs::primary:amqp
   

4. Validate the configured events.

   Perform an action on the bucket for which you configured the new event and check the AMQP 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 AMQP service endpoint for supporting bucket notifications in an AIStor Server.

1. List configured AMQP endpoints in the deployment.

   Use the mc admin config get command to list the currently configured AMQP service endpoints in the deployment:

   mc admin config get ALIAS/ notify_amqp
   

   Replace ALIAS with the alias of the MinIO deployment.

   The command output resembles the following:

   notify_amqp:primary delivery_mode="0" exchange_type="" no_wait="off" queue_dir="" queue_limit="0"  url="amqp://user:password@hostname:port" auto_deleted="off" durable="off" exchange="" internal="off" mandatory="off" routing_key=""
   notify_amqp:secondary delivery_mode="0" exchange_type="" no_wait="off" queue_dir="" queue_limit="0"  url="amqp://user:password@hostname:port" auto_deleted="off" durable="off" exchange="" internal="off" mandatory="off" routing_key=""
   

   The notify_amqp key is the top-level configuration key for an AMQP Notification Settings. The url key specifies the AMQP service endpoint for the given notify_amqp key. The notify_amqp:<IDENTIFIER> suffix describes the unique identifier for that AMQP service endpoint.

   Note the identifier for the AMQP service endpoint you want to update for the next step.

2. Update the AMQP endpoint.

   Use the mc admin config set command to set the new configuration for the AMQP service endpoint:`

   mc admin config set ALIAS/ notify_amqp:<IDENTIFIER> \
      url="amqp://user:password@hostname:port" \
      exchange="<string>" \
      exchange_type="<string>" \
      routing_key="<string>" \
      mandatory="<string>" \
      durable="<string>" \
      no_wait="<string>" \
      internal="<string>" \
      auto_deleted="<string>" \
      delivery_mode="<string>" \
      queue_dir="<string>" \
      queue_limit="<string>" \
      comment="<string>"
   

   The notify_amqp url configuration setting is the minimum required for an AMQP service endpoint. All other configuration settings are optional. See AMQP Notification Settings for a complete list of AMQP configuration settings.

3. Restart the AIStor Server.

   You must restart the AIStor Server 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 AMQP target similar to the following:

   SQS ARNs: arn:minio:sqs::primary:amqp
   

4. Validate the changes.

   Perform an action on a bucket which has an event configuration using the updated AMQP service endpoint and check the AMQP 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