From b4bfde0e0bfb4ee5b96c23d73d9eabcd44ee9681 Mon Sep 17 00:00:00 2001 From: Sai Medhini Reddy Maryada <117196660+saimedhi@users.noreply.github.com> Date: Thu, 5 Jan 2023 15:46:52 -0800 Subject: [PATCH] Added new OpenSearch versions and updated compatibility matrix (#257) * Added new OpenSearch versions and updated compatibility matrix Signed-off-by: saimedhi * Compatibility with OpenSearch 2.1.0 - 2.4.1 Signed-off-by: saimedhi Signed-off-by: saimedhi Co-authored-by: Daniel (dB.) Doubrovkine --- .github/workflows/integration.yml | 6 ++++++ CHANGELOG.md | 1 + COMPATIBILITY.md | 24 +++++++----------------- 3 files changed, 14 insertions(+), 17 deletions(-) diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml index e4a59fef..fb2da4a7 100644 --- a/.github/workflows/integration.yml +++ b/.github/workflows/integration.yml @@ -25,6 +25,12 @@ jobs: - { opensearch_version: 1.3.3 } - { opensearch_version: 2.0.0 } - { opensearch_version: 2.0.1 } + - { opensearch_version: 2.1.0 } + - { opensearch_version: 2.2.0 } + - { opensearch_version: 2.2.1 } + - { opensearch_version: 2.3.0 } + - { opensearch_version: 2.4.0 } + - { opensearch_version: 2.4.1 } steps: - name: Checkout diff --git a/CHANGELOG.md b/CHANGELOG.md index 66d9e72e..a13534d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Document Keberos authenticaion ([214](https://github.com/opensearch-project/opensearch-py/pull/214)) - Add release workflows ([#240](https://github.com/opensearch-project/opensearch-py/pull/240)) - Added SigV4 support for Async Opensearch Client ([#254](https://github.com/opensearch-project/opensearch-py/pull/254)) +- Compatibility with OpenSearch 2.1.0 - 2.4.1 ([#257](https://github.com/opensearch-project/opensearch-py/pull/257)) ### Changed - Updated getting started to user guide ([#233](https://github.com/opensearch-project/opensearch-py/pull/233)) - Updated CA certificate handling to check OpenSSL environment variables before defaulting to certifi ([#196](https://github.com/opensearch-project/opensearch-py/pull/196)) diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md index 46c780e9..59d8529b 100644 --- a/COMPATIBILITY.md +++ b/COMPATIBILITY.md @@ -5,23 +5,13 @@ The below matrix shows the compatibility of the [`opensearch-py`](https://pypi.org/project/opensearch-py/) with versions of [`OpenSearch`](https://opensearch.org/downloads.html#opensearch). -| OpenSearch Version | Client Version | -| --- | --- | -| 1.0.0 | 1.0.0 | -| 1.0.1 | 1.0.0 | -| 1.1.0 | 1.1.0 | -| 1.2.0 | 1.1.0 | -| 1.2.1 | 1.0.0 | -| 1.2.2 | 1.0.0 | -| 1.2.3 | 1.0.0 | -| 1.2.4 | 1.0.0 | -| 1.3.0 | 1.1.0 | -| 1.3.1 | 1.1.0 | -| 1.3.2 | 1.1.0 | -| 1.3.3 | 1.1.0 | -| 2.0.0 | 2.0.0 | -| 2.0.1 | 2.0.0 | +| Client Version | OpenSearch Version | Notes | +| --- | --- | --- | +| 1.0.0 | 1.0.0-1.2.4 | | +| 1.1.0 | 1.3.0-1.3.7 | | +| 2.0.0 | 1.0.0-2.4.1 | client works against Opensearch Version 1.x as long as features removed in 2.0 are not used | +| 2.0.1 | 1.0.0-2.4.1 | client works against Opensearch Version 1.x as long as features removed in 2.0 are not used | ## Upgrading -Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. While `opensearch-py-client` 2.0.0 works against the latest OpenSearch 1.x, certain deprecated features removed in OpenSearch 2.0 have also been removed from the client. Please refer to the [OpenSearch documentation](https://opensearch.org/docs/latest/clients/index/) for more information. \ No newline at end of file +Major versions of OpenSearch introduce breaking changes that require careful upgrades of the client. While `opensearch-py-client` 2.0.0 works against the latest OpenSearch 1.x, certain deprecated features removed in OpenSearch 2.0 have also been removed from the client. Please refer to the [OpenSearch documentation](https://opensearch.org/docs/latest/clients/index/) for more information.