Working with Plugins

vDB OpenSearch supports you in using additional plugins to extend your OpenSearch Cluster for various use cases, for example the kNN plugin can be used for vector search and machine learning,...

Plugins Pre-installed When Initializing Cluster

Each OpenSearch Cluster comes with several default plugins to help you launch the service quickly without additional installation.

Default plugin list:

Plugin Name	Description
Alerting	Provides alerting mechanisms based on data in OpenSearch
Anomaly Detection	Detects anomalies in data using Machine Learning (ML)
Asynchronous Search	Supports asynchronous search to handle large queries without timeout.
Cross Cluster Replication	Synchronizes data between different OpenSearch Clusters.
Custom Codecs	Allows using custom codecs for data storage.
Flow Framework	Visual data flow management tool, supports workflow-based data processing.
Notebooks	Supports note-taking and interacting with OpenSearch data in Jupyter Notebook style.
Notifications	Manages and sends notifications from OpenSearch to different channels like Slack, Email, Webhook.
Reports Scheduler	Creates and schedules automatic report exports.
Geospatial	Supports searching and analyzing data with geographical elements (GIS).
Index Management	Manages index lifecycle, optimizes storage performance and data queries.
Job Scheduler	Supports scheduling and managing periodic tasks in OpenSearch.
k-NN	Supports approximate search (k-Nearest Neighbor Search) for AI/ML.
ML Commons	Built-in Machine Learning framework to run ML models directly on OpenSearch
Skills	Supports integrating AI/ML models into OpenSearch.
Neural Search	AI/Deep Learning-based search instead of traditional keyword search.
Observability	Monitors the OpenSearch system by collecting and displaying metrics.
Performance Analyzer	Monitors the OpenSearch system by collecting and displaying metrics.
Security	Supports user authentication, authorization and data protection.
Security Analytics	Security analysis based on log data.
SQL	Allows using SQL to query OpenSearch.
opensearch-system-templates	OpenSearch system templates, supports configuration management.
query-insights	Analyzes and optimizes query performance in OpenSearch.

Optional Plugins for Installation

In addition to default plugins, you can choose to install additional plugins when initializing the cluster.

Optional plugin list:

Plugin Name	Description
analysis-icu	Supports text analysis and processing with advanced Unicode characters
analysis-kuromoji	Japanese language tokenizer
analysis-nori	Korean language tokenizer
analysis-phonetic	Supports search based on pronunciation rather than spelling
analysis-smartcn	Simplified Chinese language tokenizer.
analysis-ukrainian	Ukrainian language analyzer.
discovery-azure-classic	Supports discovering OpenSearch nodes on Microsoft Azure Classic platform.
discovery-ec2	Supports discovering OpenSearch nodes in AWS EC2.
discovery-gce	Supports discovering OpenSearch nodes in Google Cloud (GCE).
ingest-attachment	Allows indexing content of attached files such as PDF, Word, Excel, PowerPoint.
mapper-annotated-text	Supports processing annotated text.
mapper-murmur3	Provides Murmur3 hash function to create hash values for documents.
mapper-size	Stores document size as a metadata field.
repository-azure	Supports storing snapshots on Microsoft Azure Blob Storage.
repository-gcs	Supports storing snapshots on Google Cloud Storage (GCS).
repository-hdfs	Supports storing snapshots on HDFS (Hadoop Distributed File System).
repository-s3	Supports storing snapshots on Amazon S3.
store-smb	Supports storing data on SMB (Server Message Block) system.
transport-nio	Provides non-blocking IO (NIO) data transport protocol for OpenSearch.

Note:

• Currently, you cannot add or remove plugins after the OpenSearch Cluster has been initialized.

• If you want to change the plugin set, you need to create a new OpenSearch Cluster with all the desired plugins.