task(IndexAPI) Migrate IndexAPI to OpenSearch Refs #34728#34834
Open
fabrizzio-dotCMS wants to merge 13 commits intomainfrom
Open
task(IndexAPI) Migrate IndexAPI to OpenSearch Refs #34728#34834fabrizzio-dotCMS wants to merge 13 commits intomainfrom
fabrizzio-dotCMS wants to merge 13 commits intomainfrom
Conversation
…otCMS/core into issue-34728-migrate-ESIndexAPI
spbolton
approved these changes
Mar 4, 2026
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
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.
Summary
This PR migrates the index management layer from a tightly-coupled Elasticsearch-only implementation to a vendor-neutral `IndexAPI` interface, establishing the foundation for OpenSearch support alongside the existing Elasticsearch stack.
Changes
Testing
Run the OpenSearch integration tests against a local `opensearch-upgrade` container on `http://localhost:9201\`:
```bash
./mvnw verify -pl :dotcms-integration
-Dcoreit.test.skip=false
-Dopensearch.upgrade.test=true
-Dit.test=OSIndexAPIImplIntegrationTest
```
Override the endpoint if needed: `-Dopensearch.test.endpoint=http://myhost:9201\`
Existing Elasticsearch integration tests (`ESIndexAPITest`, `ContentletIndexAPIImplTest`, `ESSiteSearchAPITest`) continue to pass unchanged since `IndexAPIImpl` still delegates to `ESIndexAPI`.
Breaking Changes
`APILocator.getESIndexAPI()` return type changed from `ESIndexAPI` to `IndexAPI`, but all call sites have been updated. The `ESIndexAPI.Status` enum has been removed in favour of `IndexAPI.Status` (same values: `ACTIVE`, `INACTIVE`, `PROCESSING`).
This PR fixes: #34728