You're viewing version 1.1 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Standalone plugin install

If you don’t want to use the all-in-one installation options, you can install the various plugins for OpenSearch Dashboards individually.

Table of contents

1. Plugin compatibility
2. Prerequisites
3. Install
4. List installed plugins
5. Remove plugins
6. Update plugins

Plugin compatibility

alertingDashboards          1.1.0.0
anomalyDetectionDashboards  1.1.0.0
ganttChartDashboards        1.1.0.0
indexManagementDashboards   1.1.0.0
notebooksDashboards         1.1.0.0
queryWorkbenchDashboards    1.1.0.0
reportsDashboards           1.1.0.0
securityDashboards          1.1.0.0
traceAnalyticsDashboards    1.1.0.0

alertingDashboards          1.0.0.0
anomalyDetectionDashboards  1.0.0.0
ganttChartDashboards        1.0.0.0
indexManagementDashboards   1.0.1.0
notebooksDashboards         1.0.0.0
queryWorkbenchDashboards    1.0.0.0
reportsDashboards           1.0.1.0
securityDashboards          1.0.1.0
traceAnalyticsDashboards    1.0.0.0

alertingDashboards          1.0.0.0
anomalyDetectionDashboards  1.0.0.0
ganttChartDashboards        1.0.0.0
indexManagementDashboards   1.0.0.0
notebooksDashboards         1.0.0.0
queryWorkbenchDashboards    1.0.0.0
reportsDashboards           1.0.0.0
securityDashboards          1.0.0.0
traceAnalyticsDashboards    1.0.0.0

Prerequisites

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

Install

Navigate to the OpenSearch Dashboards home directory (likely /usr/share/opensearch-dashboards) and run the install command for each plugin.

List installed plugins

To check your installed plugins:

sudo bin/opensearch-dashboards-plugin list

Remove plugins

To remove a plugin:

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

Then remove all associated entries from opensearch_dashboards.yml.

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

sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*

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. Remove the old version:

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

2. Remove the optimized bundle:

   sudo rm /usr/share/opensearch-dashboards/optimize/bundles/<bundle-name>
   

3. Reinstall the new version:

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

4. Restart OpenSearch Dashboards.

For example, to remove and reinstall the anomaly detection plugin:

sudo bin/opensearch-plugin remove opensearch-anomaly-detection
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*
sudo bin/opensearch-dashboards-plugin install <AD OpenSearch Dashboards plugin artifact URL>