Link Search Menu Expand Document Documentation Menu
Documentation

You're viewing version 2.17 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.

Managing OpenSearch Dashboards plugins

OpenSearch Dashboards provides a command line tool called opensearch-dashboards-plugin for managing plugins. This tool allows you to:

  • List installed plugins.
  • Install plugins.
  • Remove an installed plugin.

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 Name Repository Earliest Available Version
Alerting Dashboards alerting-dashboards-plugin 1.0.0
Anomaly Detection Dashboards anomaly-detection-dashboards-plugin 1.0.0
Custom Import Maps Dashboards dashboards-maps 2.2.0
Search Relevance Dashboards dashboards-search-relevance 2.4.0
Gantt Chart Dashboards gantt-chart 1.0.0
Index Management Dashboards index-management-dashboards-plugin 1.0.0
Notebooks Dashboards dashboards-notebooks 1.0.0
Notifications Dashboards dashboards-notifications 2.0.0
Observability Dashboards dashboards-observability 2.0.0
Query Workbench Dashboards query-workbench 1.0.0
Reports Dashboards dashboards-reporting 1.0.0
Security Analytics Dashboards security-analytics-dashboards-plugin 2.4.0
Security Dashboards security-dashboards-plugin 1.0.0

Install

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

Viewing a list of installed plugins

To view the list of installed plugins from the command line, use the following command:

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 “optimize” 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.

Updating 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-dashboards-plugin remove anomalyDetectionDashboards
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>
350 characters left

Have a question? .

Want to contribute? or .