Fixes #26775: Use empty default for OIDC_CUSTOM_PARAMS to fix Compose brace-parsing#26965
Conversation
|
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! |
There was a problem hiding this comment.
Pull request overview
This PR fixes a Docker Compose interpolation edge case that could generate malformed YAML for customParams in OpenMetadata OIDC config when OIDC_CUSTOM_PARAMS is unset (notably in some Compose-compatible runtimes like Podman Compose).
Changes:
- Quote the default value for
OIDC_CUSTOM_PARAMSin Compose interpolation from${OIDC_CUSTOM_PARAMS:-{}}to${OIDC_CUSTOM_PARAMS:-"{}"}. - Apply the same fix consistently across quickstart, production, and development Compose files.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
docker/docker-compose-quickstart/docker-compose.yml |
Quotes OIDC_CUSTOM_PARAMS default to avoid brace-parsing ambiguity in Compose interpolation. |
docker/docker-compose-quickstart/docker-compose-postgres.yml |
Same quoting fix for the Postgres quickstart Compose. |
docker/docker-compose-quickstart/docker-compose-rdf.yml |
Same quoting fix for the RDF quickstart Compose. |
docker/docker-compose-openmetadata/docker-compose-openmetadata.yml |
Same quoting fix for the OpenMetadata Compose bundle. |
docker/development/docker-compose.yml |
Same quoting fix for the development Compose. |
docker/development/docker-compose-postgres.yml |
Same quoting fix for the Postgres development Compose. |
docker/development/docker-compose-gcp.yml |
Same quoting fix for the GCP development Compose. |
docker/development/docker-compose-postgres-fuseki.yml |
Same quoting fix for the Postgres+Fuseki development Compose. |
1f6b0cb to
60195fe
Compare
a7b0ee7 to
8853646
Compare
…o fix Compose brace-parsing
Code Review 👍 Approved with suggestions 0 resolved / 1 findingsFixes Compose brace-parsing for OIDC_CUSTOM_PARAMS by adjusting the default value. Note that the actual change differs from the PR description—verify the empty default is the intended fix rather than quoted braces. 💡 Quality: PR description does not match actual change📄 docker/development/docker-compose-gcp.yml:122 📄 docker/development/docker-compose-gcp.yml:336 The PR description states the fix is to change 🤖 Prompt for agentsOptionsDisplay: compact → Showing less information. Comment with these commands to change:
Was this helpful? React with 👍 / 👎 | Gitar |
Describe your changes:
Fixes #26775
Docker Compose rejects
${OIDC_CUSTOM_PARAMS:-{}}because the bare braces{}conflict with Compose's variable substitution syntax, causing a parse error on startup.Changed the default from
${OIDC_CUSTOM_PARAMS:-{}}to${OIDC_CUSTOM_PARAMS:-}(empty default) across all 8 Docker Compose files. This is correct because:conf/openmetadata.yamlalready usescustomParams: ${OIDC_CUSTOM_PARAMS:-}(empty default)getCustomParams() != nullbefore using the valueOIDC_CUSTOM_PARAMSFiles changed:
docker/development/docker-compose.ymldocker/development/docker-compose-postgres.ymldocker/development/docker-compose-gcp.ymldocker/development/docker-compose-postgres-fuseki.ymldocker/docker-compose-openmetadata/docker-compose-openmetadata.ymldocker/docker-compose-quickstart/docker-compose.ymldocker/docker-compose-quickstart/docker-compose-postgres.ymldocker/docker-compose-quickstart/docker-compose-rdf.ymlValidation: All compose files pass
docker compose config --quiet(GCP file fails due to a pre-existing unrelatedGOOGLE_APPLICATION_CREDENTIALSissue).Type of change:
Checklist:
Fixes <issue-number>: <short explanation>docker compose config --quieton all 8 files.Summary by Gitar
DataObservabilityGovernanceTab.spec.tsomjobdeploymentsThis will update automatically on new commits.