Link Search Menu Expand Document

This documentation remains in a beta state. It has content gaps and might contain bugs.

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

OpenSearch Dashboards version Plugin versions
1.0.0-rc1
alertingDashboards          1.0.0.0-rc1
anomalyDetectionDashboards  1.0.0.0-rc1
ganttChartDashboards        1.0.0.0-rc1
indexManagementDashboards   1.0.0.0-rc1
notebooksDashboards         1.0.0.0-rc1
queryWorkbenchDashboards    1.0.0.0-rc1
reportsDashboards           1.0.0.0-rc1
securityDashboards          1.0.0.0-rc1
traceAnalyticsDashboards    1.0.0.0-rc1
1.0.0-beta1
alertingDashboards          1.0.0.0-beta1
anomalyDetectionDashboards  1.0.0.0-beta1
ganttChartDashboards        1.0.0.0-beta1
indexManagementDashboards   1.0.0.0-beta1
notebooksDashboards         1.0.0.0-beta1
queryWorkbenchDashboards    1.0.0.0-beta1
reportsDashboards           1.0.0.0-beta1
securityDashboards          1.0.0.0-beta1
traceAnalyticsDashboards    1.0.0.0-beta1

Prerequisites

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>