Skip to content

Commit fcdbbc0

Browse files
Update the compatiblity mode section of the docs (#3098)
* Update the compatiblity mode section of the docs * merge with compatiblity section in index.md
1 parent dd39579 commit fcdbbc0

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

docs/reference/connecting.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -277,13 +277,6 @@ client = Elasticsearch(
277277
```
278278

279279

280-
## Enabling the Compatibility Mode [compatibility-mode]
281-
282-
The {{es}} 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 Python {{es}} {{es}} client with an 8.x {{es}} server, giving more room to coordinate the upgrade of your codebase to the next major version.
283-
284-
If you want to leverage this functionality, please make sure that you are using the latest 7.x Python {{es}} client and set the environment variable `ELASTIC_CLIENT_APIVERSIONING` to `true`. The client is handling the rest internally. For every 8.0 and beyond Python {{es}} client, you’re all set! The compatibility mode is enabled by default.
285-
286-
287280
## Using the Client in a Function-as-a-Service Environment [connecting-faas]
288281

289282
This section illustrates the best practices for leveraging the {{es}} client in a Function-as-a-Service (FaaS) environment.

docs/reference/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,14 @@ Compatibility does not imply full feature parity. New {{es}} features are suppor
6969

7070
{{es}} language clients are also _backward compatible_ across minor versions — with default distributions and without guarantees.
7171

72+
### Major version upgrades
73+
7274
:::{tip}
7375
To upgrade to a new major version, first upgrade {{es}}, then upgrade the Python {{es}} client.
7476
:::
7577

76-
If you need to work with multiple client versions, note that older versions are also released as `elasticsearch7` and `elasticsearch8`.
78+
Since version 8.0, the {{es}} server supports a compatibility mode that allows smoother upgrade experiences. In a nutshell, this makes it possible to upgrade the {{es}} server to the next major version, while continuing to use the same client. This gives more room to coordinate the upgrade of your codebase to the next major version.
79+
80+
For example, to upgrade a system that uses {{es}} 8.x you can upgrade the {{es}} server to 9.x first, and the 8.x Python {{es}} client will continue to work (aside from any breaking changes, which should be listed in the server release notes). You can continue using the 8.x client during the server migration, and only upgrade it once the server migration is complete. The process is described in detail in the [REST API compatibility workflow](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/compatibility#_rest_api_compatibility_workflow) section of the {{es}} documentation.
81+
82+
If you need to work with multiple client versions, note that older versions are also released with the `elasticsearch8` and `elasticsearch9` package names so that they can be installed together.

0 commit comments

Comments
 (0)