Skip to content

Commit 3e89a1f

Browse files
gilzowgilzow
authored
Merge pull request #4469 from platformsh/4126-new-plugins-for-opensearch-20
feat: added alternative plugins section
2 parents eb2f44e + b21583f commit 3e89a1f

File tree

3 files changed

+88
-1
lines changed

3 files changed

+88
-1
lines changed

‎sites/platform/.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@ elixir:
171171
- '1.10'
172172
- '1.9'
173173
supported:
174+
- '1.18'
174175
- '1.15'
175176
- '1.14'
176177
legacy:
@@ -702,6 +703,7 @@ postgresql:
702703
- '9.4'
703704
- '9.3'
704705
supported:
706+
- '17'
705707
- '16'
706708
- '15'
707709
- '14'
@@ -720,6 +722,7 @@ postgresql:
720722
- '11'
721723
- '10'
722724
supported:
725+
- '17'
723726
- '16'
724727
- '15'
725728
- '14'

‎sites/platform/src/add-services/opensearch.md

+43
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,49 @@ This is the complete list of plugins that can be enabled:
374374
| `repository-s3` | Support for using S3 as a repository for Snapshot/Restore | * | * |
375375
| `transport-nio` | Support for NIO transport | * | * |
376376

377+
### Alternative plugins
378+
379+
**These plugins are currently available for `OpenSearch 2.0` only.** The names below show exactly how they should be added to your configuration. For example, to use the `alerting` plugin, specify it in your `services.yaml` as so:
380+
381+
```yaml {configFile="services"}
382+
# The name of the service container. Must be unique within a project.
383+
opensearch:
384+
type: "opensearch:{{% latest "opensearch" %}}"
385+
disk: 1024
386+
configuration:
387+
plugins:
388+
- alerting
389+
```
390+
391+
{{< note title="Different names used" theme="warning" >}}
392+
393+
It should be noted that **these names may differ to what they are commonly known as** in the [OpenSearch docs](https://opensearch.org/docs/latest/). To help your understanding of what each plugin does, please click each plugin name for a link to the corresponding Github repository.
394+
395+
{{< /note >}}
396+
397+
398+
| Plugin | Description | 1 | 2 |
399+
---------------------------------------------------------------------------------------------------------|--------------|-------|---|
400+
| [`alerting`](https://github.com/opensearch-project)| Monitor data and send alert notifications automatically | N/A | * |
401+
|[`opensearch-anomaly-detection`](https://github.com/opensearch-project/anomaly-detection)| Detect anomalies as your log data and monitor data in near real time | N/A | * |
402+
|[`asynchronous-search`](https://github.com/opensearch-project/asynchronous-search)|Run search queries in the background and retrieve results as they become available | N/A | * |
403+
|[`opensearch-cross-cluster-replication`](https://github.com/opensearch-project/cross-cluster-replication)|Replicate data across two OpenSearch clusters | N/A | * |
404+
|[`opensearch-custom-codecs`](https://github.com/opensearch-project/custom-codecs)| Provide custom Lucene codecs for loading through Apache Lucene's `NamedSPILoader` | N/A | * |
405+
|[`opensearch-flow-framework`](https://github.com/opensearch-project/flow-frame)| Innovate AI applications on OpenSearch | N/A | * |
406+
|[`notifications`](https://github.com/opensearch-project/notifications)| A central location for all of your notifications from OpenSearch plugins | N/A | * |
407+
|[`opensearch-reports-scheduler`](https://github.com/opensearch-project/reporting)|Export and share reports from OpenSearch Dashboards dashboards, saved search, alerts and visualizations | N/A | * |
408+
|[`geospatial`](https://github.com/opensearch-project/geospatial)|An OpenSearch plugin that contains geospatial specific features | N/A | * |
409+
|[`opensearch-index-management`](https://github.com/opensearch-project/index-management)|A suite of features to monitor and manage indexes | N/A | * |
410+
|[`opensearch-job-scheduler`](https://github.com/opensearch-project/job-scheduler)|Schedule periodical jobs running within OpenSearch nodes | N/A | * |
411+
|[`opensearch-knn`](https://github.com/opensearch-project/k-NN)|Easily run the nearest neighbor search on billions of documents | N/A | * |
412+
|[`opensearch-ml-plugin`](https://github.com/opensearch-project/ml-commons/)|Leverage existing Open source machine learning algorithms | N/A | * |
413+
|[`opensearch-skills`](https://github.com/opensearch-project/skills)|Provides tools for ml-common's agent framework OpenSearch ml-commons. | N/A | * |
414+
|[`neural-search`](https://github.com/opensearch-project/neural-search)|Index documents and conduct a neural search on indexed documents | N/A | * |
415+
|[`opensearch-observability`](https://github.com/opensearch-project/observability)|Collection of plugins and applications that let you visualize data-driven events | N/A | * |
416+
|[`performance-analyzer`](https://github.com/opensearch-project/performance-analyzer)|A REST API that allows you to query numerous performance metrics | N/A | * |
417+
|[`opensearch-sql-plugin`](https://github.com/opensearch-project/sql)|Extract insights out of OpenSearch using the familiar SQL or Piped Processing Language (PPL) query syntax | N/A | * |
418+
419+
377420
### Plugin removal
378421

379422
Removing plugins previously added in your `{{< vendor/configfile "services" >}}` file doesn't automatically uninstall them from your OpenSearch instances.

‎sites/upsun/src/add-services/opensearch.md

+42-1
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ In this example you'd have the ICU analysis plugin and the size mapper plugin.
408408

409409
If there is a publicly available plugin you need that isn't listed here, [contact support](/learn/overview/get-support.md).
410410

411-
### Available plugins
411+
### Available plugins
412412

413413
This is the complete list of plugins that can be enabled:
414414

@@ -428,6 +428,47 @@ This is the complete list of plugins that can be enabled:
428428
| `repository-s3` | Support for using S3 as a repository for Snapshot/Restore | * | * |
429429
| `transport-nio` | Support for NIO transport | * | * |
430430

431+
432+
### Alternative plugins
433+
434+
**These plugins are currently available for `OpenSearch 2.0` only.** The names below show exactly how they should be added to your configuration. For example, to use the `alerting` plugin, specify it in your `services.yaml` as so:
435+
436+
```yaml {configFile="services"}
437+
services:
438+
opensearch:
439+
configuration:
440+
plugins:
441+
- alerting
442+
```
443+
444+
{{< note title="Different names used" theme="warning" >}}
445+
446+
It should be noted that **these names may differ to what they are commonly known as in the [OpenSearch docs](https://opensearch.org/docs/latest/).** To help your understanding of what each plugin does, please click each plugin for a link to the corresponding GitHub repositories.
447+
448+
{{< /note >}}
449+
450+
451+
| Plugin | Description | 1 | 2 |
452+
---------------------------------------------------------------------------------------------------------|--------------|-------|---|
453+
| [`alerting`](https://github.com/opensearch-project)| Monitor data and send alert notifications automatically | N/A | * |
454+
|[`opensearch-anomaly-detection`](https://github.com/opensearch-project/anomaly-detection)| Detect anomalies as you log and monitor data in near real time | N/A | * |
455+
|[`asynchronous-search`](https://github.com/opensearch-project/asynchronous-search)|Run search queries in the background and retrieve results as they become available | N/A | * |
456+
|[`opensearch-cross-cluster-replication`](https://github.com/opensearch-project/cross-cluster-replication)|Replicate data across two opensearch clusters | N/A | * |
457+
|[`opensearch-custom-codecs`](https://github.com/opensearch-project/custom-codecs)| Provide custom Lucene codecs for loading through Apache Lucene's `NamedSPILoader` | N/A | * |
458+
|[`opensearch-flow-framework`](https://github.com/opensearch-project/flow-frame)| Innovate AI applications on OpenSearch | N/A | * |
459+
|[`notifications`](https://github.com/opensearch-project/notifications)| A central location for all of your notifications from OpenSearch plugins | N/A | * |
460+
|[`opensearch-reports-scheduler`](https://github.com/opensearch-project/reporting)|Export and share reports from OpenSearch Dashboards dashboards, saved search, alerts and visualizations | N/A | * |
461+
|[`geospatial`](https://github.com/opensearch-project/geospatial)|An OpenSearch plugin that contains geospatial specific features | N/A | * |
462+
|[`opensearch-index-management`](https://github.com/opensearch-project/index-management)|A suite of features to monitor and manage indexes | N/A | * |
463+
|[`opensearch-job-scheduler`](https://github.com/opensearch-project/job-scheduler)|Schedule periodical jobs running within OpenSearch nodes | N/A | * |
464+
|[`opensearch-knn`](https://github.com/opensearch-project/k-NN)|Run the nearest neighbor search on billions of documents | N/A | * |
465+
|[`opensearch-ml-plugin`](https://github.com/opensearch-project/ml-commons/)|Leverage existing Open source machine learning algorithms | N/A | * |
466+
|[`opensearch-skills`](https://github.com/opensearch-project/skills)|Provides tools for ml-common's agent framework `OpenSearch ml-commons` | N/A | * |
467+
|[`neural-search`](https://github.com/opensearch-project/neural-search)|Index documents and conduct a neural search on indexed documents | N/A | * |
468+
|[`opensearch-observability`](https://github.com/opensearch-project/observability)|Collection of plugins and applications to visualize data-driven events | N/A | * |
469+
|[`performance-analyzer`](https://github.com/opensearch-project/performance-analyzer)|A REST API to query numerous performance metrics | N/A | * |
470+
|[`opensearch-sql-plugin`](https://github.com/opensearch-project/sql)|Extract insights out of OpenSearch using SQL or Piped Processing Language (PPL) | N/A | * |
471+
431472
### Plugin removal
432473

433474
Removing plugins previously added in your `{{< vendor/configfile "services" >}}` file doesn't automatically uninstall them from your OpenSearch instances.

0 commit comments

Comments
 (0)