Skip to content
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.

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

feat(storage): add support for Elasticsearch 8 #2523

Closed
wants to merge 52 commits into from
Closed

Conversation

rolljee
Copy link
Contributor

@rolljee rolljee commented Feb 14, 2024

What does this PR do ?

  • This PR introduce the support of Elasticsearch 8

The choice made is to keep kuzzle compatible to avoid breaking changes around the support of ES8.

We wanted to allow the user to OPT-IN for the feature. By default the majorVersion support will be 7 until Kuzzle v3.

So now, and new key is available under

{
  "services": {
    "storageEngine": {
      "majorVersion": 8
    }
  }
}

This key will load the wanted sdk version and will allow the user to use the new features of ES8.

[ ] - Documentation
[ ] - tests

How should this be manually tested?

  • Step 1 : Play with the majorVersion key
  • Step 2 : docker compose up -d

Other changes

  • Linting

@rolljee rolljee added changelog:new-features Increase the minor version number 2.x labels Feb 14, 2024
@Kuruyia Kuruyia changed the title Feat/es8 feat(storage): add support for Elasticsearch 8 Feb 14, 2024
@rolljee rolljee marked this pull request as draft March 6, 2024 08:36
Copy link
Contributor

@Kuruyia Kuruyia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: we might want to update the copyright dates in the source files (in a separate PR).

doc/2/guides/elasticsearch/v8/index.md Outdated Show resolved Hide resolved
doc/2/guides/elasticsearch/v8/index.md Outdated Show resolved Hide resolved
doc/2/guides/elasticsearch/v8/index.md Outdated Show resolved Hide resolved
doc/2/guides/elasticsearch/v8/index.md Outdated Show resolved Hide resolved
doc/2/guides/elasticsearch/v8/index.md Outdated Show resolved Hide resolved
doc/2/guides/elasticsearch/v8/index.md Outdated Show resolved Hide resolved
@@ -19,18 +22,54 @@ runs:
shell: bash

- run: |
export KUZZLE_IMAGE=${{ inputs.KUZZLE_IMAGE }}
docker compose -f ./.ci/services.yml up -d
export KUZZLE_IMAGE=${{ inputs.kuzzle-image }}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Create a new script run-services.sh that allow us to remove this piece of code

@@ -66,7 +66,16 @@ services:
retries: 30

elasticsearch:
image: kuzzleio/elasticsearch:7
image: elasticsearch:8.11.3
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep ES 7 as the default

Copy link

sonarcloud bot commented Mar 28, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
30 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
52.3% Duplication on New Code

See analysis details on SonarCloud


:::info
Kuzzle cannot connect to both Elasticsearch 7 and Elasticsearch 8 at the same time.
:::
Copy link

@afondard afondard Apr 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it's not ::: but ``` here on these 7 lines (info & warning)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the kuzzle documentation paradigm :)

* Update your clients and integrations to the latest version that's compatible with Elasticsearch 8.x, if not done already.
* Monitor your cluster using the Monitoring API or third-party monitoring services.
1. Troubleshoot
* If you encounter any issues during the migration process, take advantage of the Elasticsearch documentation, forums, and issue trackers for troubleshooting information and support.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Align bullet point with the others

Suggested change
* If you encounter any issues during the migration process, take advantage of the Elasticsearch documentation, forums, and issue trackers for troubleshooting information and support.
* If you encounter any issues during the migration process, take advantage of the Elasticsearch documentation, forums, and issue trackers for troubleshooting information and support.

Copy link

sonarcloud bot commented May 14, 2024

Quality Gate Passed Quality Gate passed

Issues
6 New issues
24 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
52.3% Duplication on New Code

See analysis details on SonarCloud

@rolljee
Copy link
Contributor Author

rolljee commented May 15, 2024

Elasticsearch-8 branch has been created, work will continue from there.

Thanks everyone that has participated in this.

@rolljee rolljee closed this May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x changelog:new-features Increase the minor version number
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants