Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update compatibility matrix and remove setting [issue 517] #558

Merged
merged 8 commits into from
May 23, 2022
Merged

update compatibility matrix and remove setting [issue 517] #558

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fff42db
remove instances of setting that is no longer available in OS2.0
alicejw1 May 5, 2022
31decfa
add note to legacy clients matrix
alicejw1 May 5, 2022
776c6fe
update note for 2.0 incompatible with legacy clients
alicejw1 May 5, 2022
da027fb
for issue 517 override setting not supported for legacy clients in Op…
alicejw1 May 16, 2022
7dbe65f
for clarity about setting deprecated in 1.x and removed in 2.0.
alicejw1 May 16, 2022
997bd48
for requester's PR review and updates for accuracy
alicejw1 May 18, 2022
bd5e27a
for small fix to move note syntax into commented-out section
alicejw1 May 18, 2022
90a5a61
for editor's feedback updates
alicejw1 May 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions _clients/agents-and-ingestion-tools/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,14 @@ redirect_from:

Historically, many multiple popular agents and ingestion tools have worked with Elasticsearch OSS, such as Beats, Logstash, Fluentd, FluentBit, and OpenTelemetry. OpenSearch aims to continue to support a broad set of agents and ingestion tools, but not all have been tested or have explicitly added OpenSearch compatibility.

As an intermediate compatibility solution, OpenSearch has a setting that instructs the cluster to return version 7.10.2 rather than its actual version.
Previously, an intermediate compatibility solution was available. OpenSearch had a setting that instructs the cluster to return version 7.10.2 rather than its actual version.
alicejw1 marked this conversation as resolved.
Show resolved Hide resolved

The Override main response setting `compatibility.override_main_response_version` is deprecated from OpenSearch version 1.x and removed from OpenSearch 2.0.0. This setting is no longer supported for compatibility with legacy clients.
alicejw1 marked this conversation as resolved.
Show resolved Hide resolved
{: .note}

{: .note}

<!--
If you use clients that include a version check, such as versions of Logstash OSS or Filebeat OSS between 7.x - 7.12.x, enable the setting:

```json
Expand All @@ -32,7 +38,7 @@ PUT _cluster/settings
```yml
compatibility.override_main_response_version: true
```

-->
Logstash OSS 8.0 introduces a breaking change where all plugins run in ECS compatibility mode by default. If you use a compatible [OSS client](#compatibility-matrices) you must override the default value to maintain legacy behavior:

```yml
Expand Down
4 changes: 4 additions & 0 deletions _clients/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ For example, a 1.0.0 client works with an OpenSearch 1.1.0 cluster, but might no

Most clients that work with Elasticsearch OSS 7.10.2 *should* work with OpenSearch, but the latest versions of those clients might include license or version checks that artificially break compatibility. This page includes recommendations around which versions of those clients to use for best compatibility with OpenSearch.

{: .note}
OpenSearch 2.0.0 no longer supports compatibility with legacy clients. Due to breaking changes with REST APIs, some features are not supported when using OpenSearch 1.x clients to connect with OpenSearch 2.0.
alicejw1 marked this conversation as resolved.
Show resolved Hide resolved


Client | Recommended version
:--- | :---
[Java low-level REST client](https://search.maven.org/artifact/org.elasticsearch.client/elasticsearch-rest-client/7.13.4/jar) | 7.13.4
Expand Down
1 change: 0 additions & 1 deletion _opensearch/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ You don't mark settings in `opensearch.yml` as persistent or transient, and sett
```yml
cluster.name: my-application
action.auto_create_index: true
compatibility.override_main_response_version: true
```

The demo configuration includes a number of settings for the security plugin that you should modify before using OpenSearch for a production workload. To learn more, see [Security]({{site.url}}{{site.baseurl}}/security-plugin/).