docs/source/reference/minio-server/settings/notifications/elasticsearch.rst

Elasticsearch Notification Settings

minio

Table of Contents

This page documents settings for configuring an Elasticsearch service as a target for Bucket Notifications <minio-bucket-notifications>. See minio-bucket-notifications-publish-elasticsearch for a tutorial on using these settings.

Multiple Elasticsearch Targets

You can specify multiple Elasticsearch service endpoints by appending a unique identifier _ID for each set of related settings. For example, the following commands set two distinct Elasticsearch service endpoints as PRIMARY and SECONDARY, respectively:

Examples

Environment Variables

set MINIO_NOTIFY_ELASTICSEARCH_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_ELASTICSEARCH_URL_PRIMARY="https://user:password@elasticsearch-endpoint.example.net:9200"
set MINIO_NOTIFY_ELASTICSEARCH_INDEX_PRIMARY="bucketevents"
set MINIO_NOTIFY_ELASTICSEARCH_FORMAT_PRIMARY="namespace"

set MINIO_NOTIFY_ELASTICSEARCH_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_ELASTICSEARCH_URL_SECONDARY="https://user:password@elasticsearch-endpoint.example.net:9200"
set MINIO_NOTIFY_ELASTICSEARCH_INDEX_SECONDARY="bucketevents"
set MINIO_NOTIFY_ELASTICSEARCH_FORMAT_SECONDARY="namespace"

Configuration Settings

mc admin config set notify_elasticsearch:primary \ 
   url="user:password@https://elasticsearch-endpoint.example.net:9200" \
   index="bucketevents" \
   format="namespace" \
   [ARGUMENT=VALUE ...]

mc admin config set notify_elasticsearch:secondary \
   url="user:password@https://elasticsearch-endpoint.example.net:9200" \
   index="bucketevents" \
   format="namespace" \
   [ARGUMENT=VALUE ...]

Notice that for configuration settings, the unique identifier appends to notify_elasticsearch only, not to each individual argument.

Settings

Enable

Required

Environment Variable

MINIO_NOTIFY_ELASTICSEARCH_ENABLE

Specify on to enable publishing bucket notifications to an Elasticsearch service endpoint.

Defaults to off.

Requires specifying the following additional environment variables if set to on:

• MINIO_NOTIFY_ELASTICSEARCH_URL
• MINIO_NOTIFY_ELASTICSEARCH_INDEX
• MINIO_NOTIFY_ELASTICSEARCH_FORMAT

Configuration Setting

notify_elasticsearch

The top-level configuration key for defining an Elasticsearch service endpoint for use with MinIO bucket notifications <minio-bucket-notifications>.

Use mc admin config set to set or update an Elasticsearch service endpoint. The following arguments are required for each target:

• ~notify_elasticsearch.url
• ~notify_elasticsearch.index
• ~notify_elasticsearch.format

Specify additional optional arguments as a whitespace (" ")-delimited list.

mc admin config set notify_elasticsearch \ 
  url="https://user:password@elasticsearch.example.com:9200" \
  [ARGUMENT="VALUE"] ... \

URL

Required

Environment Variable

MINIO_NOTIFY_ELASTICSEARCH_URL

Configuration Setting

notify_elasticsearch url

Specify the Elasticsearch service endpoint to which MinIO publishes bucket events. For example, https://elasticsearch.example.com:9200.

MinIO supports passing authentication information using as URL parameters using the format PROTOCOL://USERNAME:PASSWORD@HOSTNAME:PORT.

Index

Required

Environment Variable

MINIO_NOTIFY_ELASTICSEARCH_INDEX

Configuration Setting

notify_elasticsearch index

Specify the name of the Elasticsearch index in which to store or update MinIO bucket events. Elasticsearch automatically creates the index if it does not exist.

Format

Required

Environment Variable

MINIO_NOTIFY_ELASTICSEARCH_FORMAT

Configuration Setting

notify_elasticsearch format

Specify the format of event data written to the Elasticsearch index. MinIO supports the following values:

namespace

For each bucket event, MinIO creates a JSON document with the bucket and object name from the event as the document ID and the actual event as part of the document body. Additional updates to that object modify the existing index entry for that object. Similarly, deleting the object also deletes the corresponding index entry.

access

For each bucket event, MinIO creates a JSON document with the event details and appends it to the index with an Elasticsearch-generated random ID. Additional updates to an object result in new index entries, and existing entries remain unmodified.

Username

Optional

Environment Variable

MINIO_NOTIFY_ELASTICSEARCH_USERNAME

Configuration Setting

notify_elasticsearch username

The username for connecting to an Elasticsearch service endpoint which enforces authentication.

Password

Optional

Environment Variable

MINIO_NOTIFY_ELASTICSEARCH_PASSWORD

Configuration Setting

notify_elasticsearch password

The password for connecting to an Elasticsearch service endpoint which enforces authentication.

RELEASE.2023-06-23T20-26-00Z

MinIO redacts this value when returned as part of mc admin config get.

Queue Directory

Optional

Environment Variable

MINIO_NOTIFY_ELASTICSEARCH_QUEUE_DIR

Configuration Setting

notify_elasticsearch queue_dir

Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as /opt/minio/events.

MinIO stores undelivered events in the specified store while the Elasticsearch service is offline and replays the stored events when connectivity resumes.

Queue Limit

Optional

Environment Variable

MINIO_NOTIFY_ELASTICSEARCH_QUEUE_LIMIT

Configuration Setting

notify_elasticsearch queue_limit

Specify the maximum limit for undelivered messages. Defaults to 100000.

Comment

Optional

Environment Variable

MINIO_NOTIFY_ELASTICSEARCH_COMMENT

Configuration Setting

notify_elasticsearch comment

Specify a comment to associate with the Elasticsearch configuration.