From 2f27a9fb26b3faaeddb1034587472fd4feb721ee Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Tue, 15 Nov 2022 14:53:55 -0500 Subject: [PATCH] Adds plugin compatibility (#1856) * Adds plugin compatibility Signed-off-by: Fanit Kolchina * Added new 2.4 plugins Signed-off-by: Fanit Kolchina * Added plugin repos for dashboards plugins Signed-off-by: Fanit Kolchina * Implemented review comments Signed-off-by: Fanit Kolchina * More plugin changes Signed-off-by: Fanit Kolchina Signed-off-by: Fanit Kolchina --- _dashboards/install/plugins.md | 36 +++++++++------ _opensearch/install/plugins.md | 80 ++++++++++++++++++---------------- 2 files changed, 65 insertions(+), 51 deletions(-) diff --git a/_dashboards/install/plugins.md b/_dashboards/install/plugins.md index 74928a4d..a2fb81af 100644 --- a/_dashboards/install/plugins.md +++ b/_dashboards/install/plugins.md @@ -20,26 +20,34 @@ If you don't want to use the all-in-one installation options, you can install th ## Plugin compatibility -| Plugin Name | OpenSearch Dashboards version | -| :--- | :--- | -| alertingDashboards | 1.0.0 or newer | -| anomalyDetectionDashboards | 1.0.0 or newer | -| ganttChartDashboards | 1.0.0 or newer | -| indexManagementDashboards | 1.0.0 or newer | -| notebooksDashboards | 1.0.0 or newer | -| notificationsDashboards | 2.0.0.0 or newer | -| observabilityDashboards | 2.0.0.0 or newer | -| queryWorkbenchDashboards | 1.0.0 or newer | -| reportsDashboards | 1.0.0 or newer | -| securityDashboards | 1.0.0 or newer | -| traceAnalyticsDashboards | 1.0.0 or newer | +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. +{: .warning} ## Prerequisites - 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}}/) (e.g. OpenSearch Dashboards 1.0.0 works with OpenSearch 1.0.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 + +The following table lists available OpenSearch Dashboards plugins. + +| Plugin Name | Repository | Earliest Available Version | +| :--- | :--- | :--- | +| Alerting Dashboards | [alerting-dashboards-plugin](https://github.com/opensearch-project/alerting-dashboards-plugin) | 1.0.0 | +| Anomaly Detection Dashboards | [anomaly-detection-dashboards-plugin](https://github.com/opensearch-project/anomaly-detection-dashboards-plugin) | 1.0.0 | +| Custom Import Maps Dashboards | [dashboards-maps](https://github.com/opensearch-project/dashboards-maps) | 2.2.0 | +| Search Relevance Dashboards | [dashboards-search-relevance](https://github.com/opensearch-project/dashboards-search-relevance) | 2.4.0 | +| Gantt Chart Dashboards | [gantt-chart](https://github.com/opensearch-project/dashboards-visualizations/tree/main/gantt-chart) | 1.0.0 | +| Index Management Dashboards | [index-management-dashboards-plugin](https://github.com/opensearch-project/index-management-dashboards-plugin) | 1.0.0 | +| Notebooks Dashboards | [dashboards-notebooks](https://github.com/opensearch-project/dashboards-notebooks) | 1.0.0 | +| Notifications Dashboards | [notifications](https://github.com/opensearch-project/notifications) | 2.0.0 | +| Observability Dashboards | [dashboards-observability](https://github.com/opensearch-project/observability/tree/main/dashboards-observability) | 2.0.0 | +| Query Workbench Dashboards | [query-workbench](https://github.com/opensearch-project/sql/tree/main/workbench) | 1.0.0 | +| Reports Dashboards | [dashboards-reports](https://github.com/opensearch-project/dashboards-reports) | 1.0.0 | +| Security Analytics Dashboards | [security-analytics-dashboards-plugin](https://github.com/opensearch-project/security-analytics-dashboards-plugin)| 2.4.0 | +| Security Dashboards | [security-dashboards-plugin](https://github.com/opensearch-project/security-analytics-dashboards-plugin) | 1.0.0 | ## Install diff --git a/_opensearch/install/plugins.md b/_opensearch/install/plugins.md index 462befa5..d4f411b2 100644 --- a/_opensearch/install/plugins.md +++ b/_opensearch/install/plugins.md @@ -205,27 +205,33 @@ bin/opensearch-plugin install --batch ## Available plugins +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. +{: .warning} + ### Bundled Plugins The following plugins are bundled with all OpenSearch distributions except for minimum distribution packages. -| Plugin Name | Repository | OpenSearch Compatible Versions | +| Plugin Name | Repository | Earliest Available Version | | :--- | :--- | :--- | -| Alerting | [opensearch-alerting](https://github.com/opensearch-project/alerting) | 1.0.0 or newer | -| Anomaly Detection | [opensearch-anomaly-detection](https://github.com/opensearch-project/anomaly-detection) | 1.0.0 or newer | -| Asynchronous Search | [opensearch-asynchronous-search](https://github.com/opensearch-project/asynchronous-search) | 1.0.0 or newer | -| Cross Cluster Replication | [opensearch-cross-cluster-replication](https://github.com/opensearch-project/cross-cluster-replication) | 1.1.0 or newer | -| Dashboard Notebooks1 | [opensearch-notebooks](https://github.com/opensearch-project/dashboards-notebooks) | 1.0.0 to 1.1.0 | -| Dashboard Reports | [opensearch-reports-scheduler](https://github.com/opensearch-project/dashboards-reports) | 1.0.0 or newer | -| Geospatial | [opensearch-geospatial](https://github.com/opensearch-project/geospatial) | 2.2.0 or newer | -| Index Management | [opensearch-index-management](https://github.com/opensearch-project/index-management) | 1.0.0 or newer | -| Job Scheduler | [opensearch-job-scheduler](https://github.com/opensearch-project/job-scheduler) | 1.0.0 or newer | -| k-NN | [opensearch-knn](https://github.com/opensearch-project/k-NN) | 1.0.0 or newer | -| ML Commons | [opensearch-ml](https://github.com/opensearch-project/ml-commons) | 1.3.0 or newer | -| Observability | [opensearch-observability](https://github.com/opensearch-project/observability) | 1.2.0 or newer | -| Performance Analyzer | [opensearch-performance-analyzer](https://github.com/opensearch-project/performance-analyzer) | 1.0.0 or newer | -| Security | [opensearch-security](https://github.com/opensearch-project/security) | 1.0.0 or newer | -| SQL | [opensearch-sql](https://github.com/opensearch-project/sql) | 1.0.0 or newer | +| Alerting | [opensearch-alerting](https://github.com/opensearch-project/alerting) | 1.0.0 | +| Anomaly Detection | [opensearch-anomaly-detection](https://github.com/opensearch-project/anomaly-detection) | 1.0.0 | +| Asynchronous Search | [opensearch-asynchronous-search](https://github.com/opensearch-project/asynchronous-search) | 1.0.0 | +| Cross Cluster Replication | [opensearch-cross-cluster-replication](https://github.com/opensearch-project/cross-cluster-replication) | 1.1.0 | +| Notebooks1 | [opensearch-notebooks](https://github.com/opensearch-project/dashboards-notebooks) | 1.0.0 to 1.1.0 | +| Notifications | [notifications](https://github.com/opensearch-project/notifications) | 2.0.0 +| Reports Scheduler | [opensearch-reports-scheduler](https://github.com/opensearch-project/dashboards-reports) | 1.0.0 | +| Geospatial | [opensearch-geospatial](https://github.com/opensearch-project/geospatial) | 2.2.0 | +| Index Management | [opensearch-index-management](https://github.com/opensearch-project/index-management) | 1.0.0 | +| Job Scheduler | [opensearch-job-scheduler](https://github.com/opensearch-project/job-scheduler) | 1.0.0 | +| k-NN | [opensearch-knn](https://github.com/opensearch-project/k-NN) | 1.0.0 | +| ML Commons | [opensearch-ml](https://github.com/opensearch-project/ml-commons) | 1.3.0 | +| Neural Search | [neural-search](https://github.com/opensearch-project/neural-search) | 2.4.0 | +| Observability | [opensearch-observability](https://github.com/opensearch-project/observability) | 1.2.0 | +| Performance Analyzer | [opensearch-performance-analyzer](https://github.com/opensearch-project/performance-analyzer) | 1.0.0 | +| Security | [opensearch-security](https://github.com/opensearch-project/security) | 1.0.0 | +| Security Analytics | [security-analytics](https://github.com/opensearch-project/security-analytics) | 2.4.0 | +| SQL | [opensearch-sql](https://github.com/opensearch-project/sql) | 1.0.0 | _1Dashboard Notebooks was merged in to the Observability plugin with the release of OpenSearch 1.2.0._ @@ -233,28 +239,28 @@ _1Dashboard Notebooks was merged in to the Observability plugin with Members of the OpenSearch community have built countless plugins for the service. Although it isn't possible to build an exhaustive list of every plugin, since many plugins are not maintained within the OpenSearch GitHub repository, the following list of plugins are available to be installed by name using `bin/opensearch-plugin install `. -| Plugin Name | OpenSearch Compatible Versions | +| Plugin Name | Earliest Available Version | | :--- | :--- | -| analysis-icu | 1.0.0 or newer | -| analysis-kuromoji | 1.0.0 or newer | -| analysis-nori | 1.0.0 or newer | -| analysis-phonetic | 1.0.0 or newer | -| analysis-smartcn | 1.0.0 or newer | -| analysis-stempel | 1.0.0 or newer | -| analysis-ukrainian | 1.0.0 or newer | -| discovery-azure-classic | 1.0.0 or newer | -| discovery-ec2 | 1.0.0 or newer | -| discovery-gce | 1.0.0 or newer | -| ingest-attachment | 1.0.0 or newer | -| mapper-annotated-text | 1.0.0 or newer | -| mapper-murmur3 | 1.0.0 or newer | -| mapper-size | 1.0.0 or newer | -| repository-azure | 1.0.0 or newer | -| repository-gcs | 1.0.0 or newer | -| repository-hdfs | 1.0.0 or newer | -| repository-s3 | 1.0.0 or newer | -| store-smb | 1.0.0 or newer | -| transport-nio | 1.0.0 or newer | +| analysis-icu | 1.0.0 | +| analysis-kuromoji | 1.0.0 | +| analysis-nori | 1.0.0 | +| analysis-phonetic | 1.0.0 | +| analysis-smartcn | 1.0.0 | +| analysis-stempel | 1.0.0 | +| analysis-ukrainian | 1.0.0 | +| discovery-azure-classic | 1.0.0 | +| discovery-ec2 | 1.0.0 | +| discovery-gce | 1.0.0 | +| ingest-attachment | 1.0.0 | +| mapper-annotated-text | 1.0.0 | +| mapper-murmur3 | 1.0.0 | +| mapper-size | 1.0.0 | +| repository-azure | 1.0.0 | +| repository-gcs | 1.0.0 | +| repository-hdfs | 1.0.0 | +| repository-s3 | 1.0.0 | +| store-smb | 1.0.0 | +| transport-nio | 1.0.0 | ## Related links