fix(docker): resolve QuickStart server startup failure by fixing OIDC_CUSTOM_PARAMS YAML parse error across all 8 Compose files#27330
Conversation
…rsing crash Fixes open-metadata#26775 Quote the OIDC_CUSTOM_PARAMS interpolation default across all 8 Docker Compose files to prevent brace-parsing ambiguity in Compose-compatible runtimes (Podman 5.x, some Docker Compose versions). Before: OIDC_CUSTOM_PARAMS: ${OIDC_CUSTOM_PARAMS:-{}} After: OIDC_CUSTOM_PARAMS: "${OIDC_CUSTOM_PARAMS:-{}}" The unquoted form caused compose interpolation to produce malformed YAML (customParams: {}}) which crashed the server and execute-migrate-all on startup. The quoted form preserves full env var override capability for SSO users while eliminating the malformed output. Applied to all 16 occurrences (2 per file) across: - docker/docker-compose-quickstart/docker-compose.yml - docker/docker-compose-quickstart/docker-compose-postgres.yml - docker/docker-compose-quickstart/docker-compose-rdf.yml - docker/docker-compose-openmetadata/docker-compose-openmetadata.yml - docker/development/docker-compose.yml - docker/development/docker-compose-postgres.yml - docker/development/docker-compose-postgres-fuseki.yml - docker/development/docker-compose-gcp.yml
|
Hi there 👋 Thanks for your contribution! The OpenMetadata team will review the PR shortly! Once it has been labeled as Let us know if you need any help! |
Code Review ✅ ApprovedFixes OIDC_CUSTOM_PARAMS YAML parse error causing QuickStart server startup failure across all 8 Compose files. No issues found. OptionsDisplay: compact → Showing less information. Comment with these commands to change:
Was this helpful? React with 👍 / 👎 | Gitar |
|
Hi there 👋 Thanks for your contribution! The OpenMetadata team will review the PR shortly! Once it has been labeled as Let us know if you need any help! |
|
Hi @Yashsainani123, thanks for your pr here! We had a PR submitted for this already here. Please make sure that you are assigned an issue and that there is not a PR out for it already before submitting something. We will reopen this PR if necessary. |
Summary
Fixes #26775
The OpenMetadata QuickStart was broken for users running Podman and
certain Docker Compose versions. The server and execute-migrate-all
containers would crash immediately on startup while all other containers
(MySQL/PostgreSQL, Elasticsearch, Ingestion) ran fine — making the
failure very confusing to debug.
Root Cause
The following line existed in all 8 Docker Compose files:
OIDC_CUSTOM_PARAMS: ${OIDC_CUSTOM_PARAMS:-{}}
The
{}inside the${}variable syntax confused the Compose parserbecause curly braces are special characters in Compose variable expansion.
This caused the server to receive malformed YAML:
customParams: {}}
Which crashed openmetadata.yaml parsing on startup with:
Malformed YAML at line: . . . customParams: {}}
Fix
Wrapped the entire value in double quotes across all 8 Docker Compose files:
OIDC_CUSTOM_PARAMS: "${OIDC_CUSTOM_PARAMS:-{}}"
This is consistent with the quoting convention already used for OIDC_SCOPE
in the same files. The fix:
and all Compose-compatible runtimes
Files Changed
8 files changed, 16 occurrences fixed (2 per file — once in
execute-migrate-all service, once in openmetadata-server service):
Test Plan
Type of Change
Checklist