Publish Events to Elasticsearch

AIStor Server supports publishing bucket notification events to an Elasticsearch service endpoint.

• Elasticsearch v7.0 or later.

  AIStor relies on the v7 project for Elastic connectivity. The elastic/v7 library specifically targets Elasticsearch v7.0 and is not compatible with earlier Elasticsearch versions.

• 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 Elasticsearch service endpoint for supporting bucket notifications in an AIStor Server.

1. Add the Elasticsearch endpoint to AIStor.

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

   Environment Variables

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

   • MINIO_NOTIFY_ELASTICSEARCH_ENABLE
   • MINIO_NOTIFY_ELASTICSEARCH_URL
   • MINIO_NOTIFY_ELASTICSEARCH_INDEX
   • MINIO_NOTIFY_ELASTICSEARCH_FORMAT

   export MINIO_NOTIFY_ELASTICSEARCH_ENABLE_<IDENTIFIER>="on"
   export MINIO_NOTIFY_ELASTICSEARCH_URL_<IDENTIFIER>="<ENDPOINT>"
   export MINIO_NOTIFY_ELASTICSEARCH_INDEX_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_ELASTICSEARCH_FORMAT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_ELASTICSEARCH_USERNAME_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_ELASTICSEARCH_PASSWORD_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_ELASTICSEARCH_QUEUE_DIR_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_ELASTICSEARCH_QUEUE_LIMIT_<IDENTIFIER>="<string>"
   export MINIO_NOTIFY_ELASTICSEARCH_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 Elasticsearch service endpoint on the AIStor Server, the new settings override any existing settings for that endpoint. Use mc admin config get notify_elasticsearch to review the currently configured Elasticsearch endpoints on AIStor.

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

     https://user:password@hostname:port

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

   Configuration Settings

   AIStor supports adding or updating Elasticsearch endpoints on a running minio server process using the mc admin config set command and the notify_elasticsearch 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 Elasticsearch service endpoint. The minimum required settings are:

   • url
   • index
   • format

   mc admin config set ALIAS/ notify_elasticsearch:IDENTIFIER \
      url="ENDPOINT" \
      index="<string>" \
      format="<string>" \
      username="<string>" \
      password="<string>" \
      queue_dir="<string>" \
      queue_limit="<string>" \
      comment="<string>"
   

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

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

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

     https://user:password@hostname:port

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

   SQS ARNs: arn:minio:sqs::primary:elasticsearch
   

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

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

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

   mc event add ALIAS/BUCKET arn:minio:sqs::primary:elasticsearch \
     --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:elasticsearch
   

4. Validate the configured events.

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

1. List configured Elasticsearch endpoints in the deployment.

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

   mc admin config get ALIAS/ notify_elasticsearch
   

   Replace ALIAS with the alias of the AIStor Server.

   The command output resembles the following:

   notify_elasticsearch:primary  queue_dir="" queue_limit="0"  url="https://user:password@hostname:port" format="namespace" index=""
   notify_elasticsearch:secondary queue_dir="" queue_limit="0"  url="https://user:password@hostname:port" format="namespace" index=""
   

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

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

2. Update the Elasticsearch endpoint.

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

   mc admin config set ALIAS/ notify_elasticsearch:<IDENTIFIER> \
      url="https://user:password@hostname:port" \
      index="<string>" \
      format="<string>" \
      username="<string>" \
      password="<string>" \
      queue_dir="<string>" \
      queue_limit="<string>" \
      comment="<string>"
   

   The notify_elasticsearch url configuration setting is the minimum required for an Elasticsearch service endpoint. All other configuration settings are optional. See Elasticsearch Notification Settings for a complete list of Elasticsearch 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 Elasticsearch target similar to the following:

   SQS ARNs: arn:minio:sqs::primary:elasticsearch
   

4. Validate the changes.

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