Skip to content

Commit

Permalink
Revert "[DOC] Create Dashboard list extensions documentation (#3443)"
Browse files Browse the repository at this point in the history
This reverts commit 5500edf.
  • Loading branch information
vagimeli committed May 4, 2023
1 parent 212e0f5 commit 0cfe8e5
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 59 deletions.
43 changes: 0 additions & 43 deletions _dashboards/dashboard/plugins-dashboards.md

This file was deleted.

41 changes: 28 additions & 13 deletions _install-and-configure/install-dashboards/plugins.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
---
layout: default
title: Managing OpenSearch Dashboards plugins
nav_order: 100
title: OpenSearch Dashboards plugins
parent: Installing OpenSearch Dashboards
nav_order: 50
redirect_from:
- /dashboards/install/plugins
- /install-and-configure/install-dashboards/plugins/
---

# Managing OpenSearch Dashboards plugins
# Standalone plugin install

OpenSearch Dashboards provides a command line tool called `opensearch-plugin` for managing plugins. This tool allows you to:
If you don't want to use the all-in-one installation options, you can install the various plugins for OpenSearch Dashboards individually.

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

#### Table of contents
1. TOC
{:toc}


---

## Plugin compatibility

Expand All @@ -24,7 +29,7 @@ Major, minor, and patch plugin versions must match OpenSearch major, minor, and

- A compatible OpenSearch cluster
- The corresponding OpenSearch plugins [installed on that cluster]({{site.url}}{{site.baseurl}}/opensearch/install/plugins/)
- The corresponding version of [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/) (for example, OpenSearch Dashboards 2.3.0 works with OpenSearch 2.3.0)
- The corresponding version of [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/) (for example, OpenSearch Dashboards 2.1.0 works with OpenSearch 2.1.0)

## Available plugins

Expand All @@ -48,7 +53,7 @@ The following table lists available OpenSearch Dashboards plugins.

## Install

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

{% comment %}

Expand All @@ -60,6 +65,7 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.

This plugin provides a user interface for managing users, roles, mappings, action groups, and tenants.


#### Alerting OpenSearch Dashboards

```bash
Expand All @@ -68,6 +74,7 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.

This plugin provides a user interface for creating monitors and managing alerts.


#### Index State Management OpenSearch Dashboards

```bash
Expand All @@ -76,6 +83,7 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.

This plugin provides a user interface for managing policies.


#### Anomaly Detection OpenSearch Dashboards

```bash
Expand All @@ -84,6 +92,7 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.

This plugin provides a user interface for adding detectors.


#### Query Workbench OpenSearch Dashboards

```bash
Expand All @@ -92,6 +101,7 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.

This plugin provides a user interface for using SQL queries to explore your data.


#### Trace Analytics

```bash
Expand All @@ -100,6 +110,7 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.

This plugin uses distributed trace data (indexed in OpenSearch using Data Prepper) to display latency trends, error rates, and more.


#### Notebooks OpenSearch Dashboards

```bash
Expand All @@ -108,6 +119,7 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.

This plugin lets you combine OpenSearch Dashboards visualizations and narrative text in a single interface.


#### Reports OpenSearch Dashboards

```bash
Expand All @@ -121,6 +133,7 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.

This plugin lets you export and share reports from OpenSearch Dashboards dashboards, visualizations, and saved searches.


#### Gantt Chart OpenSearch Dashboards

```bash
Expand All @@ -131,14 +144,15 @@ This plugin adds a new Gantt chart visualization.

{% endcomment %}

## Viewing a list of installed plugins
## List installed plugins

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

```bash
sudo bin/opensearch-dashboards-plugin list
```


## Remove plugins

To remove a plugin:
Expand All @@ -157,7 +171,8 @@ sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-det

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

## 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:

Expand Down
2 changes: 1 addition & 1 deletion _observing-your-data/ad/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Anomaly detection
nav_order: 80
nav_order: 90
has_children: true
redirect_from:
- /monitoring-plugins/ad/
Expand Down
2 changes: 1 addition & 1 deletion _observing-your-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Observability
nav_order: 1
has_children: true
has_children: false
redirect_from:
- /observability-plugin/index/
---
Expand Down
2 changes: 1 addition & 1 deletion _observing-your-data/notifications/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Notifications
nav_order: 90
nav_order: 80
has_children: true
redirect_from:
- /notifications-plugin/
Expand Down

0 comments on commit 0cfe8e5

Please sign in to comment.