Skip to content

Commit 54d1f76

Browse files
kolchfa-awsnatebower
kolchfa-aws
and
natebower
authored
Correct list of dashboards plugins (opensearch-project#10264)
* Correct list of dashboards plugins Signed-off-by: Fanit Kolchina <[email protected]> * Review comments Signed-off-by: Fanit Kolchina <[email protected]> * Change plugin name Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Signed-off-by: Nathan Bower <[email protected]> * Fix links Signed-off-by: Fanit Kolchina <[email protected]> * Fix link Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: Nathan Bower <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
1 parent 62d3d0d commit 54d1f76

File tree

2 files changed

+46
-138
lines changed

2 files changed

+46
-138
lines changed

‎_install-and-configure/install-dashboards/plugins.md‎

Lines changed: 45 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -28,108 +28,31 @@ Major, minor, and patch plugin versions must match OpenSearch major, minor, and
2828

2929
## Available plugins
3030

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

33-
| Plugin Name | Repository | Earliest Available Version |
33+
| Plugin name | Repository | Earliest available version |
3434
| :--- | :--- | :--- |
35-
| Alerting Dashboards | [alerting-dashboards-plugin](https://github.com/opensearch-project/alerting-dashboards-plugin) | 1.0.0 |
36-
| Anomaly Detection Dashboards | [anomaly-detection-dashboards-plugin](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin) | 1.0.0 |
37-
| Custom Import Maps Dashboards | [dashboards-maps](https://github.com/opensearch-project/dashboards-maps) | 2.2.0 |
38-
| Search Relevance Dashboards | [dashboards-search-relevance](https://github.com/opensearch-project/dashboards-search-relevance) | 2.4.0 |
39-
| Index Management Dashboards | [index-management-dashboards-plugin](https://github.com/opensearch-project/index-management-dashboards-plugin) | 1.0.0 |
40-
| Notebooks Dashboards | [dashboards-notebooks](https://github.com/opensearch-project/dashboards-notebooks) | 1.0.0 |
41-
| Notifications Dashboards | [dashboards-notifications](https://github.com/opensearch-project/dashboards-notifications) | 2.0.0 |
42-
| Observability Dashboards | [dashboards-observability](https://github.com/opensearch-project/dashboards-observability) | 2.0.0 |
43-
| Query Insights Dashboards | [query-insights-dashboards](https://github.com/opensearch-project/query-insights-dashboards) | 2.19.0 |
44-
| Query Workbench Dashboards | [query-workbench](https://github.com/opensearch-project/dashboards-query-workbench) | 1.0.0 |
45-
| Reports Dashboards | [dashboards-reporting](https://github.com/opensearch-project/dashboards-reporting) | 1.0.0 |
46-
| Security Analytics Dashboards | [security-analytics-dashboards-plugin](https://github.com/opensearch-project/security-analytics-dashboards-plugin)| 2.4.0 |
47-
| Security Dashboards | [security-dashboards-plugin](https://github.com/opensearch-project/security-dashboards-plugin) | 1.0.0 |
48-
49-
## Install
50-
51-
Navigate to the OpenSearch Dashboards home directory (for example, `/usr/share/opensearch-dashboards`) and run the install command for each plugin.
52-
53-
{% comment %}
54-
55-
#### Security OpenSearch Dashboards
56-
57-
```bash
58-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-security/opensearchSecurityOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.1.zip
59-
```
60-
61-
This plugin provides a user interface for managing users, roles, mappings, action groups, and tenants.
62-
63-
#### Alerting OpenSearch Dashboards
64-
65-
```bash
66-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-alerting/opensearchAlertingOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.0.zip
67-
```
68-
69-
This plugin provides a user interface for creating monitors and managing alerts.
70-
71-
#### Index State Management OpenSearch Dashboards
72-
73-
```bash
74-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-index-management/opensearchIndexManagementOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.1.zip
75-
```
76-
77-
This plugin provides a user interface for managing policies.
78-
79-
#### Anomaly Detection OpenSearch Dashboards
80-
81-
```bash
82-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-anomaly-detection/opensearchAnomalyDetectionOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.0.zip
83-
```
84-
85-
This plugin provides a user interface for adding detectors.
86-
87-
#### Query Workbench OpenSearch Dashboards
88-
89-
```bash
90-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-query-workbench/opensearchQueryWorkbenchOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.0.zip
91-
```
92-
93-
This plugin provides a user interface for using SQL queries to explore your data.
94-
95-
#### Trace Analytics
96-
97-
```bash
98-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-trace-analytics/opensearchTraceAnalyticsOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.2.0.zip
99-
```
100-
101-
This plugin uses distributed trace data (indexed in OpenSearch using Data Prepper) to display latency trends, error rates, and more.
102-
103-
#### Notebooks OpenSearch Dashboards
104-
105-
```bash
106-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-notebooks/opensearchNotebooksOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.2.0.zip
107-
```
108-
109-
This plugin lets you combine OpenSearch Dashboards visualizations and narrative text in a single interface.
110-
111-
#### Reports OpenSearch Dashboards
112-
113-
```bash
114-
# x86 Linux
115-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-reports/linux/x64/opensearchReportsOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.2.0-linux-x64.zip
116-
# ARM64 Linux
117-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-reports/linux/arm64/opensearchReportsOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.2.0-linux-arm64.zip
118-
# x86 Windows
119-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-reports/windows/x64/opensearchReportsOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.2.0-windows-x64.zip
120-
```
121-
122-
This plugin lets you export and share reports from OpenSearch Dashboards dashboards, visualizations, and saved searches.
123-
124-
#### Gantt Chart OpenSearch Dashboards
125-
126-
```bash
127-
sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.net/downloads/opensearch-dashboards-plugins/opensearch-gantt-chart/opensearchGanttChartOpenSearch Dashboards-{{site.opensearch_major_minor_version}}.0.0.zip
128-
```
129-
130-
This plugin adds a new Gantt chart visualization.
131-
132-
{% endcomment %}
35+
| `alertingDashboards` | [alerting-dashboards-plugin](https://github.com/opensearch-project/alerting-dashboards-plugin) | 1.0.0 |
36+
| `anomalyDetectionDashboards` | [anomaly-detection-dashboards-plugin](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin) | 1.0.0 |
37+
| `assistantDashboards` | [dashboards-assistant](https://github.com/opensearch-project/dashboards-assistant) | 2.13.0 |
38+
| `customImportMapDashboards` | [dashboards-maps](https://github.com/opensearch-project/dashboards-maps) | 2.2.0 |
39+
| `flowFrameworkDashboards` | [dashboards-flow-framework](https://github.com/opensearch-project/dashboards-flow-framework) | 2.19.0 |
40+
| `indexManagementDashboards` | [index-management-dashboards-plugin](https://github.com/opensearch-project/index-management-dashboards-plugin) | 1.0.0 |
41+
| `mlCommonsDashboards` | [ml-commons-dashboards](https://github.com/opensearch-project/ml-commons-dashboards) | 2.6.0 |
42+
| `notificationsDashboards` | [dashboards-notifications](https://github.com/opensearch-project/dashboards-notifications) | 2.0.0 |
43+
| `observabilityDashboards` | [dashboards-observability](https://github.com/opensearch-project/dashboards-observability) | 2.0.0 |
44+
| `queryInsightsDashboards` | [query-insights-dashboards](https://github.com/opensearch-project/query-insights-dashboards) | 2.19.0 |
45+
| `queryWorkbenchDashboards` | [query-workbench](https://github.com/opensearch-project/dashboards-query-workbench) | 1.0.0 |
46+
| `reportsDashboards` | [dashboards-reporting](https://github.com/opensearch-project/dashboards-reporting) | 1.0.0 |
47+
| `searchRelevanceDashboards` | [dashboards-search-relevance](https://github.com/opensearch-project/dashboards-search-relevance) | 2.4.0 |
48+
| `securityAnalyticsDashboards` | [security-analytics-dashboards-plugin](https://github.com/opensearch-project/security-analytics-dashboards-plugin)| 2.4.0 |
49+
| `securityDashboards` | [security-dashboards-plugin](https://github.com/opensearch-project/security-dashboards-plugin) | 1.0.0 |
50+
51+
_<sup>*</sup>`dashboardNotebooks` was merged into the Observability plugin with the release of OpenSearch 1.2.0._<br>
52+
53+
## Installing a plugin
54+
55+
For information about installing Dashboards plugins, see [Downloading bundled plugins for offline installation]({{site.url}}{{site.baseurl}}/install-and-configure/plugins/#downloading-bundled-plugins-for-offline-installation).
13356

13457
## Viewing a list of installed plugins
13558

@@ -138,53 +61,38 @@ To view the list of installed plugins from the command line, use the following c
13861
```bash
13962
sudo bin/opensearch-dashboards-plugin list
14063
```
64+
{% include copy.html %}
14165

142-
## Remove plugins
143-
144-
To remove a plugin:
66+
The command returns the list of installed plugins and their versions:
14567

14668
```bash
147-
sudo bin/opensearch-dashboards-plugin remove <plugin-name>
69+
[email protected]
70+
[email protected]
71+
[email protected]
72+
[email protected]
73+
[email protected]
74+
[email protected]
75+
[email protected]
76+
[email protected]
77+
[email protected]
78+
[email protected]
79+
[email protected]
80+
[email protected]
81+
[email protected]
82+
[email protected]
14883
```
14984

150-
Then remove all associated entries from `opensearch_dashboards.yml`.
85+
## Removing a plugin
15186

152-
For certain plugins, you must also remove the "optimize" bundle. This is a sample command for the Anomaly Detection plugin:
87+
To remove a plugin, use the following command:
15388

15489
```bash
155-
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*
90+
sudo bin/opensearch-dashboards-plugin remove alertingDashboards
15691
```
92+
{% include copy.html %}
15793

158-
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.
94+
Then remove all associated entries from `opensearch_dashboards.yml` and restart OpenSearch Dashboards.
15995

16096
## Updating plugins
16197

162-
OpenSearch Dashboards doesn’t update plugins. Instead, you have to remove the old version and its optimized bundle, reinstall them, and restart OpenSearch Dashboards:
163-
164-
1. Remove the old version:
165-
166-
```bash
167-
sudo bin/opensearch-dashboards-plugin remove <plugin-name>
168-
```
169-
170-
1. Remove the optimized bundle:
171-
172-
```bash
173-
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/<bundle-name>
174-
```
175-
176-
1. Reinstall the new version:
177-
178-
```bash
179-
sudo bin/opensearch-dashboards-plugin install <plugin-name>
180-
```
181-
182-
1. Restart OpenSearch Dashboards.
183-
184-
For example, to remove and reinstall the Anomaly Detection plugin:
185-
186-
```bash
187-
sudo bin/opensearch-dashboards-plugin remove anomalyDetectionDashboards
188-
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*
189-
sudo bin/opensearch-dashboards-plugin install <AD OpenSearch Dashboards plugin artifact URL>
190-
```
98+
OpenSearch Dashboards doesn't update plugins. Instead, you must [remove the old version](#removing-a-plugin), [reinstall the plugin](#installing-a-plugin), and restart OpenSearch Dashboards.

‎_security/configuration/disable-enable-security.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ To perform these steps on the Docker image, see [Working with plugins]({{site.ur
6565

6666
### Removing the Security plugin from OpenSearch Dashboards
6767

68-
If you disable the Security plugin in `opensearch.yml` and still want to use OpenSearch Dashboards, you must remove the corresponding OpenSearch Dashboards Security plugin. For more information, see [Remove plugins]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/plugins/#remove-plugins).
68+
If you disable the Security plugin in `opensearch.yml` and still want to use OpenSearch Dashboards, you must remove the corresponding OpenSearch Dashboards Security plugin. For more information, see [Remove plugins]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/plugins/#removing-a-plugin).
6969

7070
Refer to the following installation types to remove the OpenSearch Dashboards plugin.
7171

0 commit comments

Comments
 (0)