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.

Plugin compatibility

Major, minor, and patch plugin versions must match OpenSearch major, minor, and patch versions in order to be compatible. For example, plugins versions 2.3.0.x work only with OpenSearch 2.3.0.

Prerequisites

Available plugins

The following table lists available OpenSearch Dashboards plugins.

Plugin NameRepositoryEarliest Available Version
Alerting Dashboardsalerting-dashboards-plugin1.0.0
Anomaly Detection Dashboardsanomaly-detection-dashboards-plugin1.0.0
Custom Import Maps Dashboardsdashboards-maps2.2.0
Search Relevance Dashboardsdashboards-search-relevance2.4.0
Gantt Chart Dashboardsgantt-chart1.0.0
Index Management Dashboardsindex-management-dashboards-plugin1.0.0
Notebooks Dashboardsdashboards-notebooks1.0.0
Notifications Dashboardsnotifications2.0.0
Observability Dashboardsdashboards-observability2.0.0
Query Workbench Dashboardsquery-workbench1.0.0
Reports Dashboardsdashboards-reports1.0.0
Security Analytics Dashboardssecurity-analytics-dashboards-plugin2.4.0
Security Dashboardssecurity-dashboards-plugin1.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:

  1. sudo bin/opensearch-dashboards-plugin list

Remove plugins

To remove a plugin:

  1. 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:

  1. 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:

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

  2. Remove the optimized bundle:

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

  3. Reinstall the new version:

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

  4. Restart OpenSearch Dashboards.

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

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