docs: research report and migration roadmap for replacing olivere/elastic#8205
Draft
Amaan729 wants to merge 1 commit intojaegertracing:mainfrom
Draft
docs: research report and migration roadmap for replacing olivere/elastic#8205Amaan729 wants to merge 1 commit intojaegertracing:mainfrom
Amaan729 wants to merge 1 commit intojaegertracing:mainfrom
Conversation
Adds a migration roadmap documenting: - Candidate modern clients (elastic/go-elasticsearch, opensearch-go) - Method-by-method mapping against the shim interfaces - Recommended phased migration plan - Proof-of-concept implementation of ClusterAPI.Version() Closes jaegertracing#7612
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related to #7612
Summary
This PR adds a research document and migration roadmap for replacing the deprecated
olivere/elasticGo library with a modern, maintained client.Document:
docs/elasticsearch-client-migration.mdThe doc covers:
1. Background — why
olivere/elasticis blocking and must be replaced, and how the existing shim atinternal/storage/elasticsearch/client/interfaces.goisolates the blast radius.2. Candidate clients — detailed comparison of:
elastic/go-elasticsearchv8 (official Elastic client)opensearch-project/opensearch-gov2 (official OpenSearch client)3. Method mapping table — every method in
IndexAPI,ClusterAPI, andIndexManagementLifecycleAPImapped to its equivalent in both candidate clients.Key finding: All
IndexAPIandClusterAPImethods have direct equivalents in both clients. The only non-trivial gap isIndexManagementLifecycleAPI: Elasticsearch uses ILM while OpenSearch uses ISM, which have different API shapes and need separate shim implementations.4. Recommended phased migration
es/andos/sub-packages, factory selects at runtime)olivere/elasticfromgo.mod5. Proof-of-concept — a working Go implementation of
ClusterAPI.Version()usinggo-elasticsearchv8 to validate the approach. Not wired into the build yet.6. Open questions — ES 7 vs 8 support, auth/TLS plumbing, bulk-indexer API differences.
What this PR does NOT do
This is intentionally a research/planning PR per the issue guidance. Implementation will follow in separate issues/PRs once the approach is confirmed by maintainers.
Checklist
internal/storage/elasticsearch/client/interfaces.go