Skip to content

[Backport 7.15] Document compatibility mode #6004

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

Merged
merged 1 commit into from
Sep 22, 2021
Merged

[Backport 7.15] Document compatibility mode #6004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions docs/client-concepts/high-level/getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,17 @@ var settings = new ConnectionSettings(connectionPool)
var client = new ElasticClient(settings);
----

[float]
==== Enabling the Compatibility Mode

The Elasticsearch server version 8.0 is introducing a new compatibility mode that allows you a smoother upgrade
experience from 7 to 8. In a nutshell, you can use the latest 7.x Elasticsearch client with an 8.x Elasticsearch
server, giving more room to coordinate the upgrade of your codebase to the next major version.

If you want to leverage this functionality, please make sure that you are using the latest 7.x client and set
the environment variable `ELASTIC_CLIENT_APIVERSIONING` to `true`. The client is handling the rest internally.
For every 8.0 and beyond client, you're all set! The compatibility mode is enabled by default.

[float]
=== Using the Client in a Function-as-a-Service Environment

Expand Down
13 changes: 13 additions & 0 deletions tests/Tests/ClientConcepts/HighLevel/GettingStarted.doc.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,19 @@ public void UsingConnectionPool()
var client = new ElasticClient(settings);
}

/**[float]
* ==== Enabling the Compatibility Mode
*
* The Elasticsearch server version 8.0 is introducing a new compatibility mode that allows you a smoother upgrade
* experience from 7 to 8. In a nutshell, you can use the latest 7.x Elasticsearch client with an 8.x Elasticsearch
* server, giving more room to coordinate the upgrade of your codebase to the next major version.

* If you want to leverage this functionality, please make sure that you are using the latest 7.x client and set
* the environment variable `ELASTIC_CLIENT_APIVERSIONING` to `true`. The client is handling the rest internally.
* For every 8.0 and beyond client, you're all set! The compatibility mode is enabled by default.
*
*/

/**[float]
* === Using the Client in a Function-as-a-Service Environment
*
Expand Down