Publish Events to MySQL — MinIO Object Storage for Linux (original) (raw)

Table of Contents

MinIO supports publishing bucket notification events to a MySQLservice endpoint. MinIO supports MySQL 5.7.8 and later only.

Add a MySQL Endpoint to a MinIO Deployment

The following procedure adds a new MySQL service endpoint for supportingbucket notifications in a MinIO deployment.

Prerequisites

MySQL 5.7.8 and later

MinIO relies on features introduced with MySQL 5.7.8.

MinIO mc Command Line Tool

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

1) Add the MySQL Endpoint to MinIO

You can configure a new MySQL service endpoint using either environment variables_or_ by setting runtime configuration settings.

Environment Variables

MinIO supports specifying the MySQL service endpoint and associated configuration settings usingenvironment variables. Theminio server process applies the specified settings on its next startup.

The following example code sets all environment variables related to configuring a MySQL service endpoint. The minimum_required_ variables are:

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

Configuration Settings

MinIO supports adding or updating MySQL endpoints on a runningminio server process using the mc admin config set command and the notify_mysql configuration key. You must restart theminio server process to apply any new or updated configuration settings.

The following example code sets all settings related to configuring an MySQL service endpoint. The minimum required settings are:

mc admin config set ALIAS/ notify_mysql:IDENTIFIER
dsn_string=""
table=""
format=""
max_open_connections=""
queue_dir=""
queue_limit=""
comment=""

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

1) Restart the MinIO Deployment

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 MySQL target similar to the following:

SQS ARNs: arn:minio:sqs::primary:mysql

You must specify the ARN resource when configuring bucket notifications with the associated MySQL 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

  1. Copy and run the following command, replacing ALIAS with the alias of the deployment.
    mc admin info --json ALIAS
  2. 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:mysql.

Use jq to parse the JSON for the value

  1. Install jq
  2. 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:mysql

3) Configure Bucket Notifications using the MySQL Endpoint as a Target

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

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

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

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

4) Validate the Configured Events

Perform an action on the bucket for which you configured the new event and check the MySQL 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 thes3:ObjectCreated:Put event, you can use themc cp command to create a new object in the bucket and trigger a notification.

mc cp ~/data/new-object.txt ALIAS/BUCKET

Update a MySQL Endpoint in a MinIO Deployment

The following procedure updates an existing MySQL service endpoint for supportingbucket notifications in a MinIO deployment.

Prerequisites

MySQL 5.7.8 and later

MinIO relies on features introduced with MySQL 5.7.8.

MinIO mc Command Line Tool

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

1) List Configured MySQL Endpoints In The Deployment

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

mc admin config get ALIAS/ notify_mysql

Replace ALIAS with the alias of the MinIO deployment.

The command output resembles the following:

notify_mysql:primary format="namespace" table="minio_images" dsn_string="user:pass@tcp(mysql.example.com:3306)/miniodb" notify_mysql:secondary format="namespace" table="minio_images" dsn_string="user:pass@tcp(mysql.example.com:3306)/miniodb"

The notify_mysql key is the top-level configuration key for anMySQL Notification Settings. Thedsn_string key specifies the MySQL service endpoint for the given notify_mysql key. The notify_mysql:<IDENTIFIER>suffix describes the unique identifier for that MySQL service endpoint.

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

2) Update the MySQL Endpoint

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

mc admin config set ALIAS/ notify_mysql:IDENTIFIER
dsn_string=""
table=""
format=""
max_open_connections=""
queue_dir=""
queue_limit=""
comment=""

The following configuration settings are the minimum required for a MySQL service endpoint:

All other configuration settings are optional. SeeMySQL Notification Settings for a complete list of MySQL configuration settings.

3) Restart the MinIO Deployment

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 MySQL target similar to the following:

SQS ARNs: arn:minio:sqs::primary:mysql

4) Validate the Changes

Perform an action on a bucket which has an event configuration using the updated MySQL service endpoint and check the MySQL 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 thes3:ObjectCreated:Put event, you can use themc cp command to create a new object in the bucket and trigger a notification.

mc cp ~/data/new-object.txt ALIAS/BUCKET