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

Run opensearch-dashboards-plugin from the OpenSearch Dashboards installation directory, for example, /usr/share/opensearch-dashboards for RPM and Debian installations. The tool refuses to run as the root user and returns an OpenSearch Dashboards should not be run as root error. The RPM and Debian packages install the plugins directory with root ownership, so for these installations, run the tool with sudo and add the --allow-root option, as shown in the examples on this page. For tarball and Windows installations, run the tool as the user that owns the installation directory, without sudo or --allow-root.

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 --allow-root

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

alertingDashboards@3.9.0.0
anomalyDetectionDashboards@3.9.0.0
assistantDashboards@3.9.0.0
customImportMapDashboards@3.9.0.0
flowFrameworkDashboards@3.9.0.0
indexManagementDashboards@3.9.0.0
investigationDashboards@3.9.0.0
mlCommonsDashboards@3.9.0.0
notificationsDashboards@3.9.0.0
observabilityDashboards@3.9.0.0
queryInsightsDashboards@3.9.0.0
queryWorkbenchDashboards@3.9.0.0
reportsDashboards@3.9.0.0
searchRelevanceDashboards@3.9.0.0
securityAnalyticsDashboards@3.9.0.0
securityDashboards@3.9.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> --allow-root

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> --allow-root

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

The download URLs of the bundled plugins are listed in the manifest.yml file located in the root of the OpenSearch Dashboards installation directory. For more information, see Downloading bundled plugins for offline installation.

Removing plugins

To remove a plugin, use the following command:

sudo bin/opensearch-dashboards-plugin remove alertingDashboards --allow-root

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