opensearch-docs-cn/_opensearch/install/plugins.md

394 lines
12 KiB
Markdown
Raw Normal View History

2021-05-28 13:48:19 -04:00
---
layout: default
title: OpenSearch plugins
parent: Install OpenSearch
nav_order: 90
---
# OpenSearch plugin installation
2021-05-28 13:48:19 -04:00
You can install individual plugins on an OpenSearch cluster.
2021-05-28 13:48:19 -04:00
---
#### Table of contents
1. TOC
{:toc}
2021-05-28 13:48:19 -04:00
---
## Install a plugin
If you are running OpenSearch in a Docker container, plugins must be installed, removed, and configured by modifying the Docker image. For information, see [Install, configure or remove plugins]({{site.url}}{{site.baseurl}}/opensearch/install/docker#install-configure-or-remove-plugins)
{: .note}
The install command takes a plugin id, which may be any of the following:
- An official OpenSearch plugin name
- Maven coordinates to a plugin zip file
- A URL to a plugin zip file
If you're installing an official OpenSearch plugin, use:
```
bin/opensearch-plugin install <plugin-name>
```
For a plugin installed via zip, use:
```
bin/opensearch-plugin install <name|Zip File|Url>
```
Restart your OpenSearch node after installing a plugin.
## Batch mode
When installing plugins that require additional privileges not included by default, the plugins will prompt the user for confirmation of the required privileges. To grant all requested privileges, use batch mode to skip the confirmation prompt.
To force batch mode when installing plugins, add the `-b` or `--batch` option:
```
bin/opensearch-plugin install --batch <plugin-name>
```
## Remove a plugin
```
bin/opensearch-plugin remove <plugin-name>
```
Restart your OpenSearch node after removing a plugin.
## List installed plugins
To check which plugins are currently installed:
```
bin/opensearch-plugin list
```
## Available plugins
2021-05-28 13:48:19 -04:00
<table>
<thead style="text-align: left">
<tr>
<th>OpenSearch version</th>
<th>Plugin versions</th>
</tr>
</thead>
<tbody>
<tr>
<tr>
<td>2.2.0</td>
<td>
<pre>opensearch-alerting 2.2.0.0
opensearch-anomaly-detection 2.2.0.0
opensearch-asynchronous-search 2.2.0.0
opensearch-cross-cluster-replication 2.2.0.0
opensearch-index-management 2.2.0.0
opensearch-job-scheduler 2.2.0.0
opensearch-knn 2.2.0.0
opensearch-ml 2.2.0.0
opensearch-observability 2.2.0.0
opensearch-performance-analyzer 2.2.0.0
opensearch-reports-scheduler 2.2.0.0
opensearch-security 2.2.0.0
opensearch-sql 2.2.0.0
</pre>
</td>
</tr>
<tr>
<td>2.1.0.0</td>
<td>
<pre>opensearch-alerting 2.1.0.0
opensearch-anomaly-detection 2.1.0.0
opensearch-asynchronous-search 2.1.0.0
opensearch-cross-cluster-replication 2.1.0.0
opensearch-index-management 2.1.0.0
opensearch-job-scheduler 2.1.0.0
opensearch-knn 2.1.0.0
opensearch-ml 2.1.0.0
opensearch-notifications 2.1.0.0
opensearch-observability 2.1.0.0
opensearch-performance-analyzer 2.1.0.0
opensearch-reports-scheduler 2.1.0.0
opensearch-security 2.1.0.0
opensearch-sql 2.1.0.0
</pre>
</td>
</tr>
<tr>
<td>2.0.1.0</td>
<td>
<pre>opensearch-alerting 2.0.1.0
opensearch-anomaly-detection 2.0.1.0
opensearch-asynchronous-search 2.0.1.0
opensearch-cross-cluster-replication 2.0.1.0
opensearch-index-management 2.0.1.0
opensearch-job-scheduler 2.0.1.0
opensearch-knn 2.0.1.0
opensearch-ml 2.0.1.0
opensearch-notifications 2.0.1.0
opensearch-observability 2.0.1.0
opensearch-performance-analyzer 2.0.1.0
opensearch-reports-scheduler 2.0.1.0
opensearch-security 2.0.1.0
opensearch-sql 2.0.1.0
</pre>
</td>
</tr>
<tr>
<td>2.0.0.0</td>
<td>
<pre>opensearch-alerting 2.0.0.0
opensearch-anomaly-detection 2.0.0.0
opensearch-asynchronous-search 2.0.0.0
opensearch-cross-cluster-replication 2.0.0.0
opensearch-index-management 2.0.0.0
opensearch-job-scheduler 2.0.0.0
opensearch-knn 2.0.0.0
opensearch-ml 2.0.0.0
opensearch-notifications 2.0.0.0
opensearch-observability 2.0.0.0
opensearch-performance-analyzer 2.0.0.0
opensearch-reports-scheduler 2.0.0.0
opensearch-security 2.0.0.0
opensearch-sql 2.0.0.0
</pre>
</td>
</tr>
<tr>
<td>2.0.0.0-rc1</td>
<td>
<pre>opensearch-alerting 2.0.0.0-rc1
opensearch-anomaly-detection 2.0.0.0-rc1
opensearch-asynchronous-search 2.0.0.0-rc1
opensearch-cross-cluster-replication 2.0.0.0-rc1
opensearch-index-management 2.0.0.0-rc1
opensearch-job-scheduler 2.0.0.0-rc1
opensearch-knn 2.0.0.0-rc1
opensearch-ml 2.0.0.0-rc1
opensearch-observability 2.0.0.0-rc1
opensearch-performance-analyzer 2.0.0.0-rc1
opensearch-reports-scheduler 2.0.0.0-rc1
opensearch-security 2.0.0.0-rc1
opensearch-sql 2.0.0.0-rc1
</pre>
</td>
</tr>
<tr>
<td>1.3.3</td>
<td>
<pre>opensearch-alerting 1.3.3.0
opensearch-anomaly-detection 1.3.3.0
opensearch-asynchronous-search 1.3.3.0
opensearch-cross-cluster-replication 1.3.3.0
opensearch-index-management 1.3.3.0
opensearch-job-scheduler 1.3.3.0
opensearch-knn 1.3.3.0
opensearch-ml 1.3.3.0
opensearch-observability 1.3.3.0
opensearch-performance-analyzer 1.3.3.0
opensearch-reports-scheduler 1.3.3.0
opensearch-security 1.3.3.0
opensearch-sql 1.3.3.0
</pre>
</td>
</tr>
<tr>
<tr>
<td>1.3.2</td>
<td>
<pre>opensearch-alerting 1.3.2.0
opensearch-anomaly-detection 1.3.2.0
opensearch-asynchronous-search 1.3.2.0
opensearch-cross-cluster-replication 1.3.2.0
opensearch-index-management 1.3.2.0
opensearch-job-scheduler 1.3.2.0
opensearch-knn 1.3.2.0
opensearch-ml 1.3.2.0
opensearch-observability 1.3.2.0
opensearch-performance-analyzer 1.3.2.0
opensearch-reports-scheduler 1.3.2.0
opensearch-security 1.3.2.0
opensearch-sql 1.3.2.0
</pre>
</td>
</tr>
<tr>
<td>1.3.1</td>
<td>
<pre>opensearch-alerting 1.3.1.0
opensearch-anomaly-detection 1.3.1.0
opensearch-asynchronous-search 1.3.1.0
opensearch-cross-cluster-replication 1.3.1.0
opensearch-index-management 1.3.1.0
opensearch-job-scheduler 1.3.1.0
opensearch-knn 1.3.1.0
opensearch-ml 1.3.1.0
opensearch-observability 1.3.1.0
opensearch-performance-analyzer 1.3.1.0
opensearch-reports-scheduler 1.3.1.0
opensearch-security 1.3.1.0
opensearch-sql 1.3.1.0
</pre>
</td>
</tr>
<tr>
<td>1.3.0</td>
<td>
<pre>opensearch-alerting 1.3.0.0
opensearch-anomaly-detection 1.3.0.0
opensearch-asynchronous-search 1.3.0.0
opensearch-cross-cluster-replication 1.3.0.0
opensearch-index-management 1.3.0.0
opensearch-job-scheduler 1.3.0.0
opensearch-knn 1.3.0.0
opensearch-ml 1.3.0.0
opensearch-observability 1.3.0.0
opensearch-performance-analyzer 1.3.0.0
opensearch-reports-scheduler 1.3.0.0
opensearch-security 1.3.0.0
opensearch-sql 1.3.0.0
</pre>
</td>
</tr>
<tr>
<td>1.2.4</td>
<td>
<pre>opensearch-alerting 1.2.4.0
opensearch-anomaly-detection 1.2.4.0
opensearch-asynchronous-search 1.2.4.0
opensearch-cross-cluster-replication 1.2.4.0
opensearch-index-management 1.2.4.0
opensearch-job-scheduler 1.2.4.0
opensearch-knn 1.2.4.0
opensearch-observability 1.2.4.0
opensearch-performance-analyzer 1.2.4.0
opensearch-reports-scheduler 1.2.4.0
opensearch-security 1.2.4.0
opensearch-sql 1.2.4.0
</pre>
</td>
</tr>
<td>1.2.3</td>
<td>
<pre>opensearch-alerting 1.2.3.0
opensearch-anomaly-detection 1.2.3.0
opensearch-asynchronous-search 1.2.3.0
opensearch-cross-cluster-replication 1.2.3.0
opensearch-index-management 1.2.3.0
opensearch-job-scheduler 1.2.3.0
opensearch-knn 1.2.3.0
opensearch-observability 1.2.3.0
opensearch-performance-analyzer 1.2.3.0
opensearch-reports-scheduler 1.2.3.0
opensearch-security 1.2.3.0
opensearch-sql 1.2.3.0
</pre>
</td>
</tr>
<tr>
<td>1.2.2</td>
<td>
<pre>opensearch-alerting 1.2.2.0
opensearch-anomaly-detection 1.2.2.0
opensearch-asynchronous-search 1.2.2.0
opensearch-cross-cluster-replication 1.2.2.0
opensearch-index-management 1.2.2.0
opensearch-job-scheduler 1.2.2.0
opensearch-knn 1.2.2.0
opensearch-observability 1.2.2.0
opensearch-performance-analyzer 1.2.2.0
opensearch-reports-scheduler 1.2.2.0
opensearch-security 1.2.2.0
opensearch-sql 1.2.2.0
</pre>
</td>
</tr>
<tr>
<td>1.2.1</td>
<td>
<pre>opensearch-alerting 1.2.1.0
opensearch-anomaly-detection 1.2.1.0
opensearch-asynchronous-search 1.2.1.0
opensearch-cross-cluster-replication 1.2.1.0
opensearch-index-management 1.2.1.0
opensearch-job-scheduler 1.2.1.0
opensearch-knn 1.2.1.0
opensearch-observability 1.2.1.0
opensearch-performance-analyzer 1.2.1.0
opensearch-reports-scheduler 1.2.1.0
opensearch-security 1.2.1.0
opensearch-sql 1.2.1.0
</pre>
</td>
</tr>
2021-09-30 16:43:24 -04:00
<tr>
<td>1.2.0</td>
2021-09-30 16:43:24 -04:00
<td>
<pre>opensearch-alerting 1.2.0.0
opensearch-anomaly-detection 1.2.0.0
opensearch-asynchronous-search 1.2.0.0
opensearch-cross-cluster-replication 1.2.0.0
opensearch-index-management 1.2.0.0
opensearch-job-scheduler 1.2.0.0
opensearch-knn 1.2.0.0
opensearch-observability 1.2.0.0
opensearch-performance-analyzer 1.2.0.0
opensearch-reports-scheduler 1.2.0.0
opensearch-security 1.2.0.0
opensearch-sql 1.2.0.0
2021-09-30 16:43:24 -04:00
</pre>
</td>
</tr>
<tr>
<td>1.1.0</td>
<td>
<pre>opensearch-alerting 1.1.0.0
opensearch-anomaly-detection 1.1.0.0
opensearch-asynchronous-search 1.1.0.0
opensearch-cross-cluster-replication 1.1.0.0
opensearch-index-management 1.1.0.0
opensearch-job-scheduler 1.1.0.0
opensearch-knn 1.1.0.0
opensearch-notebooks 1.1.0.0
opensearch-performance-analyzer 1.1.0.0
opensearch-reports-scheduler 1.1.0.0
opensearch-security 1.1.0.0
opensearch-sql 1.1.0.0
</pre>
2021-09-30 16:43:24 -04:00
</td>
</tr>
2021-07-08 14:47:37 -04:00
<tr>
2021-09-01 14:25:39 -04:00
<td>1.0.1</td>
2021-07-08 14:47:37 -04:00
<td>
<pre>opensearch-alerting 1.0.0.0
opensearch-anomaly-detection 1.0.0.0
opensearch-asynchronous-search 1.0.0.0
2021-09-01 14:25:39 -04:00
opensearch-index-management 1.0.1.0
2021-07-08 14:47:37 -04:00
opensearch-job-scheduler 1.0.0.0
opensearch-knn 1.0.0.0
opensearch-notebooks 1.0.0.0
2021-09-01 14:25:39 -04:00
opensearch-performance-analyzer 1.0.1.0
2021-07-08 14:47:37 -04:00
opensearch-reports-scheduler 1.0.0.0
2021-09-01 14:25:39 -04:00
opensearch-security 1.0.1.0
2021-07-08 14:47:37 -04:00
opensearch-sql 1.0.0.0
</pre>
</td>
</tr>
2021-06-06 22:19:20 -04:00
<tr>
2021-09-01 14:25:39 -04:00
<td>1.0.0</td>
2021-05-28 13:48:19 -04:00
<td>
2021-09-01 14:25:39 -04:00
<pre>opensearch-alerting 1.0.0.0
opensearch-anomaly-detection 1.0.0.0
opensearch-asynchronous-search 1.0.0.0
opensearch-index-management 1.0.0.0
opensearch-job-scheduler 1.0.0.0
opensearch-knn 1.0.0.0
opensearch-notebooks 1.0.0.0
opensearch-performance-analyzer 1.0.0.0
opensearch-reports-scheduler 1.0.0.0
opensearch-security 1.0.0.0
opensearch-sql 1.0.0.0
2021-05-28 13:48:19 -04:00
</pre>
</td>
</tr>