Link Search Menu Expand Document Documentation Menu

Standalone OpenSearch plugin installation

If you don’t want to use the all-in-one OpenSearch installation options, you can install the individual plugins on a compatible OpenSearch cluster, just like any other plugin.


Table of contents

  1. Plugin compatibility
  2. List installed plugins
  3. Remove plugins
  4. Update plugins

Plugin compatibility

OpenSearch version Plugin versions
1.0.0
opensearch-alerting             1.0.0.0
opensearch-anomaly-detection    1.0.0.0
opensearch-asynchronous-search  1.0.0.0
opensearch-index-management     1.0.0.0
opensearch-job-scheduler        1.0.0.0
opensearch-knn                  1.0.0.0
opensearch-notebooks            1.0.0.0
opensearch-performance-analyzer 1.0.0.0
opensearch-reports-scheduler    1.0.0.0
opensearch-security             1.0.0.0
opensearch-sql                  1.0.0.0
1.0.0-rc1
opensearch-alerting             1.0.0.0-rc1
opensearch-anomaly-detection    1.0.0.0-rc1
opensearch-asynchronous-search  1.0.0.0-rc1
opensearch-index-management     1.0.0.0-rc1
opensearch-job-scheduler        1.0.0.0-rc1
opensearch-knn                  1.0.0.0-rc1
opensearch-notebooks            1.0.0.0-rc1
opensearch-performance-analyzer 1.0.0.0-rc1
opensearch-reports-scheduler    1.0.0.0-rc1
opensearch-security             1.0.0.0-rc1
opensearch-sql                  1.0.0.0-rc1
1.0.0-beta1
opensearch-alerting             1.0.0.0-beta1
opensearch-anomaly-detection    1.0.0.0-beta1
opensearch-asynchronous-search  1.0.0.0-beta1
opensearch-index-management     1.0.0.0-beta1
opensearch-job-scheduler        1.0.0.0-beta1
opensearch-knn                  1.0.0.0-beta1
opensearch-performance-analyzer 1.0.0.0-beta1
opensearch-reports-scheduler    1.0.0.0-beta1
opensearch-security             1.0.0.0-beta1
opensearch-sql                  1.0.0.0-beta1

To install plugins manually, you must have the exact version of OpenSearch installed, down to the minor version.

List installed plugins

To check your installed plugins:

sudo bin/opensearch-plugin list

Remove plugins

If you are removing Performance Analyzer, see below. Otherwise, you can remove the plugin with a single command:

sudo bin/opensearch-plugin remove <plugin-name>

Then restart OpenSearch on the node:

sudo systemctl restart opensearch.service

Update plugins

OpenSearch doesn’t update plugins. Instead, you have to remove and reinstall them:

sudo bin/opensearch-plugin remove <plugin-name>
sudo bin/opensearch-plugin install <plugin-name>