Standalone plugin install


Table of contents

  1. Prerequisites
  2. List installed plugins
  3. Update plugins

Prerequisites

  • A compatible OpenSearch cluster
  • The corresponding OpenSearch plugins installed on that cluster
  • The corresponding version of (e.g. OpenSearch Dashboards 1.0.0 works with OpenSearch 1.0.0)

Navigate to the OpenSearch Dashboards home directory (likely ) and run the install command for each plugin.

List installed plugins

To check your installed plugins:

  1. sudo bin/opensearch-dashboards-plugin list

To remove a plugin:

  1. sudo bin/opensearch-dashboards-plugin remove <plugin-name>

For certain plugins, you must also remove the “optimze” bundle. This is a sample command for the Anomaly Detection plugin:

Then restart OpenSearch Dashboards. After you remove any plugin, OpenSearch Dashboards performs an optimize operation the next time you start it. This operation takes several minutes even on fast machines, so be patient.

Update plugins

OpenSearch Dashboards doesn’t update plugins. Instead, you have to remove the old version and its optimized bundle, reinstall them, and restart OpenSearch Dashboards:

    1. sudo bin/opensearch-dashboards-plugin remove <plugin-name>
  1. Remove the optimized bundle:

    1. sudo rm /usr/share/opensearch-dashboards/optimize/bundles/<bundle-name>
  2. Reinstall the new version:

  3. Restart OpenSearch Dashboards.

  1. sudo bin/opensearch-plugin remove opensearch-anomaly-detection
  2. sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*