opensearch-docs-cn/_opensearch/install/plugins.md

layout	title	parent	nav_order
default	OpenSearch plugins	Install OpenSearch	90

OpenSearch plugin installation

You can install individual plugins on an OpenSearch cluster.

---

Table of contents

1. TOC {:toc}

---

Install a plugin

If you are running OpenSearch in a Docker container, plugins must be installed, removed, and configured by modifying the Docker image. For information, see Install, configure or remove plugins {: .note}

The install command takes a plugin id, which may be any of the following:

• An official OpenSearch plugin name
• Maven coordinates to a plugin zip file
• A URL to a plugin zip file

If you're installing an official OpenSearch plugin, use:

bin/opensearch-plugin install <plugin-name>

For a plugin installed via zip, use:

bin/opensearch-plugin install <name|Zip File|Url>

Restart your OpenSearch node after installing a plugin.

Batch mode

When installing plugins that require additional privileges not included by default, the plugins will prompt the user for confirmation of the required privileges. To grant all requested privileges, use batch mode to skip the confirmation prompt.

To force batch mode when installing plugins, add the -b or --batch option:

bin/opensearch-plugin install --batch <plugin-name>

Remove a plugin

bin/opensearch-plugin remove <plugin-name>

Restart your OpenSearch node after removing a plugin.

List installed plugins

To check which plugins are currently installed:

bin/opensearch-plugin list

Available plugins

Plugin Name	Repository	OpenSearch Compatible Versions
Alerting	opensearch-alerting	1.0.0 or newer
Anomaly Detection	opensearch-anomaly-detection	1.0.0 or newer
Asynchronous Search	opensearch-asynchronous-search	1.0.0 or newer
Cross Cluster Replication	opensearch-cross-cluster-replication	1.1.0 or newer
Dashboard Notebooks1	opensearch-notebooks	1.0.0 to 1.1.0
Dashboard Reports	opensearch-reports-scheduler	1.0.0 or newer
Index Management	opensearch-index-management	1.0.0 or newer
Job Scheduler	opensearch-job-scheduler	1.0.0 or newer
k-NN	opensearch-knn	1.0.0 or newer
ML Commons	opensearch-ml	1.3.0 or newer
Observability	opensearch-observability	1.2.0 or newer
Performance Analyzer	opensearch-performance-analyzer	1.0.0 or newer
Security	opensearch-security	1.0.0 or newer
SQL	opensearch-sql	1.0.0 or newer

¹Dashboard Notebooks was merged in to the Observability plugin with the release of OpenSearch 1.2.0.