Managing OpenSearch Dashboards plugins

OpenSearch Dashboards provides a command line tool called opensearch-dashboards-plugin for managing plugins.

Prerequisites

• A compatible OpenSearch cluster
• The corresponding OpenSearch plugins installed on that cluster
• The corresponding version of OpenSearch Dashboards (for example, OpenSearch Dashboards 2.3.0 works with OpenSearch 2.3.0)

Using the opensearch-dashboards-plugin tool

Use the opensearch-dashboards-plugin tool to perform the following actions:

• List installed plugins.
• Install plugins.
• Remove installed plugins.

Listing installed plugins

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

sudo bin/opensearch-dashboards-plugin list

The command returns the list of installed plugins and their versions:

alertingDashboards@3.1.0.0
anomalyDetectionDashboards@3.1.0.0
assistantDashboards@3.1.0.0
customImportMapDashboards@3.1.0.0
flowFrameworkDashboards@3.1.0.0
indexManagementDashboards@3.1.0.0
mlCommonsDashboards@3.1.0.0
notificationsDashboards@3.1.0.0
observabilityDashboards@3.1.0.0
queryInsightsDashboards@3.1.0.0
queryWorkbenchDashboards@3.1.0.0
reportsDashboards@3.1.0.0
searchRelevanceDashboards@3.1.0.0
securityAnalyticsDashboards@3.1.0.0

Installing plugins

To install a plugin, provide the URL of the plugin’s zip file:

sudo bin/opensearch-dashboards-plugin install <plugin-zip-url>

To install a plugin from a zip file on the host, provide the file path using the file:// scheme:

sudo bin/opensearch-dashboards-plugin install file:///<path-to-plugin-zip>

The plugin version must match your OpenSearch Dashboards version. For more information, see Plugin compatibility. After installing the plugin, restart OpenSearch Dashboards.

Removing plugins

To remove a plugin, use the following command:

sudo bin/opensearch-dashboards-plugin remove alertingDashboards

Then remove all associated entries from opensearch_dashboards.yml and restart OpenSearch Dashboards.

Updating plugins

The opensearch-dashboards-plugin tool does not update plugins. To update a plugin, remove the old version, install the new version, and restart OpenSearch Dashboards.

Available plugins

The following table lists available OpenSearch Dashboards plugins. All listed plugins are included in the default OpenSearch distributions.

^*dashboardNotebooks was merged into the Observability plugin with the release of OpenSearch 1.2.0.

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.

Plugin dependencies

Some plugins extend functionality of other plugins. If a plugin has a dependency on another plugin, you must install the required dependency before installing the dependent plugin. For plugin dependencies, see the manifest file. In this file, each plugin’s dependencies are listed in the depends_on parameter.

Related documentation

• Installing OpenSearch Dashboards
• Managing OpenSearch plugins