Skip to content

fix(docker): resolve QuickStart server startup failure by fixing OIDC_CUSTOM_PARAMS YAML parse error across all 8 Compose files#27330

Closed
Yashsainani123 wants to merge 1 commit intoopen-metadata:mainfrom
Yashsainani123:fix/26775-quickstart-oidc-compose-and-docs
Closed

fix(docker): resolve QuickStart server startup failure by fixing OIDC_CUSTOM_PARAMS YAML parse error across all 8 Compose files#27330
Yashsainani123 wants to merge 1 commit intoopen-metadata:mainfrom
Yashsainani123:fix/26775-quickstart-oidc-compose-and-docs

Conversation

@Yashsainani123
Copy link
Copy Markdown

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 parser
because 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:

  • Eliminates the malformed YAML output completely
  • Preserves full environment variable override capability for SSO users
  • Makes the QuickStart work correctly on Podman, Docker Desktop,
    and all Compose-compatible runtimes
  • Introduces zero breaking changes

Files Changed

8 files changed, 16 occurrences fixed (2 per file — once in
execute-migrate-all service, once in openmetadata-server service):

  • docker/docker-compose-quickstart/docker-compose.yml (lines 109, 330)
  • docker/docker-compose-quickstart/docker-compose-postgres.yml (lines 111, 332)
  • docker/docker-compose-quickstart/docker-compose-rdf.yml (lines 151, 321)
  • docker/docker-compose-openmetadata/docker-compose-openmetadata.yml (lines 63, 284)
  • docker/development/docker-compose.yml (lines 118, 341)
  • docker/development/docker-compose-postgres.yml (lines 121, 348)
  • docker/development/docker-compose-postgres-fuseki.yml (lines 122, 353)
  • docker/development/docker-compose-gcp.yml (lines 122, 336)

Test Plan

  • All 8 files pass YAML syntax validation ✅
  • Zero unquoted OIDC_CUSTOM_PARAMS:-{} lines remain in any file ✅
  • Exactly 16 quoted occurrences confirmed across all 8 files ✅
  • conf/openmetadata.yaml and distributed test configs untouched ✅
  • git diff --name-only confirms exactly 8 files changed, nothing else ✅

Type of Change

  • Bug fix (non-breaking — preserves all existing behavior)

Checklist

  • I have read the CONTRIBUTING document
  • My PR title follows the conventional commit format
  • Only the minimal necessary files were changed
  • Fix is consistent with the quoting convention already used in these files
  • No unrelated changes bundled in this PR

…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
@github-actions
Copy link
Copy Markdown
Contributor

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

@gitar-bot
Copy link
Copy Markdown

gitar-bot Bot commented Apr 13, 2026

Code Review ✅ Approved

Fixes OIDC_CUSTOM_PARAMS YAML parse error causing QuickStart server startup failure across all 8 Compose files. No issues found.

Options

Display: compact → Showing less information.

Comment with these commands to change:

Compact
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@github-actions
Copy link
Copy Markdown
Contributor

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

@PubChimps
Copy link
Copy Markdown
Contributor

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.

@PubChimps PubChimps closed this Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Issues with QuickStart

2 participants