Home GitHub
Buckit Object Storage User Guide

Publish Events to Elasticsearch

Buckit supports publishing bucket notification events to an Elasticsearch service endpoint.

Buckit relies on the https://github.com/elastic/go-elasticsearch v7 project for Elastic connectivity.

Add a Elasticsearch Endpoint to a Buckit Deployment

The following procedure adds a new Elasticsearch service endpoint for supporting bucket notifications in a Buckit deployment.

Prerequisites

Elasticsearch v7.0 and later

Buckit relies on the https://github.com/olivere/elastic v7 project for Elastic connectivity. The elastic/v7 library specifically targets Elasticsearch v7.0 and is not compatible with earlier Elasticsearch versions.

Buckit bm Command Line Tool

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

1) Add the Elasticsearch Endpoint to Buckit

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

Buckit supports specifying the Elasticsearch service endpoint and associated configuration settings using environment variables. The buckit 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:

   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 Buckit deployment, the new settings override any existing settings for that endpoint. Use bm admin config get notify_elasticsearch to review the currently configured Elasticsearch endpoints on the Buckit deployment.

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

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

Buckit supports adding or updating Elasticsearch endpoints on a running buckit server process using the bm admin config set command and the notify_elasticsearch configuration key. You must restart the buckit 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:

bm 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 Buckit deployment, the new settings override any existing settings for that endpoint. Use bm admin config get notify_elasticsearch to review the currently configured Elasticsearch endpoints on the Buckit deployment.

  • 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.

1) Restart the Buckit Deployment

You must restart the Buckit deployment to apply the configuration changes. Use the bm admin service restart command to restart the deployment.

bm admin service restart ALIAS

Replace ALIAS with the alias of the deployment to restart.

The buckit 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.

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.

    bm 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:elasticsearch.

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.

    bm admin info --json ALIAS | jq  .info.sqsARN

    This returns the ARN to use for notifications, such as arn:minio:sqs::primary:elasticsearch

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

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

bm event add ALIAS/BUCKET arn:minio:sqs::primary:elasticsearch \
  --event EVENTS

  • Replace ALIAS with the alias of a Buckit 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 Buckit triggers notifications.

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

bm 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 bm cp command to create a new object in the bucket and trigger a notification.

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

Update an Elasticsearch Endpoint in a Buckit Deployment

The following procedure updates an existing Elasticsearch service endpoint for supporting bucket notifications in a Buckit deployment.

Prerequisites

Elasticsearch v7.0 and later

Buckit relies on the https://github.com/olivere/elastic v7 project for Elastic connectivity. The elastic/v7 library specifically targets Elasticsearch v7.0 and is not compatible with earlier Elasticsearch versions.

Buckit bm Command Line Tool

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

1) List Configured Elasticsearch Endpoints In The Deployment

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

bm admin config get ALIAS/ notify_elasticsearch

Replace ALIAS with the alias of the Buckit deployment.

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 bm admin config set command to set the new configuration for the Elasticsearch service endpoint:

bm 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 Buckit Deployment

You must restart the Buckit deployment to apply the configuration changes. Use the bm admin service restart command to restart the deployment.

bm admin service restart ALIAS

Replace ALIAS with the alias of the deployment to restart.

The buckit 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 bm cp command to create a new object in the bucket and trigger a notification.

bm cp ~/data/new-object.txt ALIAS/BUCKET
Buckit documentation adapted from MinIO Open Source documentation. Licensed under the Creative Commons Attribution 4.0 International License. Creative Commons License