From b667490d6dcc9cdaa76eb6fbf5bb4f586c5c75a3 Mon Sep 17 00:00:00 2001 From: Steve Gordon Date: Wed, 22 Sep 2021 12:48:59 +0100 Subject: [PATCH] Update index and add compatibility mode to connection section (#6003) * Update connection section of getting started (cherry picked from commit 73b863f08938b4024279a48d987801969b5ef3f1) * Generate updated getting started doc --- .../high-level/getting-started.asciidoc | 11 +++++++++++ .../ClientConcepts/HighLevel/GettingStarted.doc.cs | 13 +++++++++++++ 2 files changed, 24 insertions(+) diff --git a/docs/client-concepts/high-level/getting-started.asciidoc b/docs/client-concepts/high-level/getting-started.asciidoc index 12936fc325b..901e79f1be1 100644 --- a/docs/client-concepts/high-level/getting-started.asciidoc +++ b/docs/client-concepts/high-level/getting-started.asciidoc @@ -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 diff --git a/tests/Tests/ClientConcepts/HighLevel/GettingStarted.doc.cs b/tests/Tests/ClientConcepts/HighLevel/GettingStarted.doc.cs index a665a1c4d14..d40670715a3 100644 --- a/tests/Tests/ClientConcepts/HighLevel/GettingStarted.doc.cs +++ b/tests/Tests/ClientConcepts/HighLevel/GettingStarted.doc.cs @@ -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 *