Skip to content

Minor corrections to v8 compatibility doc #6265

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
Apr 11, 2022
Merged

Minor corrections to v8 compatibility doc #6265

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
5 changes: 3 additions & 2 deletions docs/client-concepts/connection/connecting-to-elasticsearch-v8.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ please modify the original csharp file found at the link and submit the PR with
[[connecting-to-elasticsearch-v8]]
=== Connecting to Elasticsearch v8.x using the v7.17.x client

We recommend using the latest client with a corresponding major version when connecting to Elasticsearch. Until the v7 .NET client is
We recommend using the latest client with a corresponding major version when connecting to Elasticsearch. Until the v8 .NET client is
generally available, you may use the v7.17.x client to communicate with a 8.x Elasticsearch cluster. There are several important considerations
regarding configuration. Failure to correctly configure the client to connect using the security features enabled on the server will result in
an exception being thrown during the initial client communication that will prevent further use of the client.
Expand Down Expand Up @@ -69,10 +69,11 @@ var settings = new ConnectionSettings(pool)
var client = new ElasticClient(settings);
----

[[enabling-compatibility-mode]]
==== Enabling 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
experience from v7 to v8. 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
Expand Down
6 changes: 3 additions & 3 deletions tests/Tests/ClientConcepts/Connection/ConnectingToElasticsearchV8.doc.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class ConnectingToElasticsearchV8
/**[[connecting-to-elasticsearch-v8]]
* === Connecting to Elasticsearch v8.x using the v7.17.x client
*
* We recommend using the latest client with a corresponding major version when connecting to Elasticsearch. Until the v7 .NET client is
* We recommend using the latest client with a corresponding major version when connecting to Elasticsearch. Until the v8 .NET client is
* generally available, you may use the v7.17.x client to communicate with a 8.x Elasticsearch cluster. There are several important considerations
* regarding configuration. Failure to correctly configure the client to connect using the security features enabled on the server will result in
* an exception being thrown during the initial client communication that will prevent further use of the client.
Expand Down Expand Up @@ -68,18 +68,18 @@ [U] public void BasicAuth()
}

/**
* [[enabling-compatibility-mode]]
* ==== Enabling 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
* experience from v7 to v8. 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.
*
* Compatibility mode may also be enabled directly on `ConnectionSettings` by calling `EnableApiVersioningHeader`.
*/

[U] public void CompatibilityMode()
{
var pool = new SingleNodeConnectionPool(new Uri("http://localhost:9200"));
Expand Down