docs(openmetadata): warn about Elasticsearch searchType index update issue on restarts#495
Open
safayavatsal wants to merge 1 commit into
Conversation
…issue When using searchType "elasticsearch" with Elasticsearch 8.x, the run-db-migrations init container fails on pod restarts because the application sends "settings" in a PutMappingRequest, which Elasticsearch rejects. This only affects updates to existing indices — creating from scratch works fine. The default "opensearch" searchType is unaffected. - Add warning comment in values.yaml above searchType - Add description and fix default in values.schema.json (was "elasticsearch", should be "opensearch" to match values.yaml) - Add inline note in README values table for searchType - Add troubleshooting section in README with 3 workarounds - Add conditional warning in NOTES.txt shown at install/upgrade time Ref open-metadata#451
Contributor
Author
|
Taking up issue #451. The root cause is in the OpenMetadata server's Since the proper fix belongs in the OpenMetadata server repo, this PR adds documentation, warnings, and workaround guidance at the Helm chart level. Also fixes a pre-existing inconsistency where |
3 tasks
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
Ref #451
When using
searchType: elasticsearchwith Elasticsearch 8.x, therun-db-migrationsinit container fails on pod restarts with:Root cause: This is an application-level bug in
ElasticSearchIndexManager.updateIndex()which sends the full index definition (includingsettings) to the ElasticsearchPutMappingAPI. ThePutMappingendpoint only acceptsmappings, notsettings. This only occurs when updating existing indices — creating from scratch works fine. The defaultopensearchsearchType is unaffected.Since the fix requires changes to the OpenMetadata server (not the Helm chart), this PR adds documentation and warnings to help users avoid or work around the issue.
Changes
values.yaml: Added warning comment abovesearchTypeexplaining the limitationvalues.schema.json: Addeddescriptionwith warning; fixeddefaultfrom"elasticsearch"to"opensearch"(was inconsistent with actualvalues.yamldefault)README.md: Added inline note in the values table forsearchType; added "Troubleshooting Elasticsearch Index Updates" section with 3 workaroundsNOTES.txt: Added conditional warning shown athelm install/upgradetime whensearchType: elasticsearchis detectedWorkarounds documented
searchType: opensearchreindexConfig.enabledfor periodic rebuildsTest plan
helm lintpasses with default values (opensearch)helm lintpasses withsearchType: elasticsearchhelm templaterenders cleanly for both searchType valuessearchType: elasticsearch