Settings Configuration Source
Settings can come from the deployment configuration (openmetadata.yaml and its environment variables) and from the database, where the UI and the API save them. The configSource block in the server configuration decides which one wins for each settings group.
Settings Groups and Modes
Set each group with its environment variable toAUTO, ENV, or DB.
Modes:
AUTO: A value that you change in the deployment configuration is applied on the next start, unless someone changed the same value through the API since then. In that case, OpenMetadata keeps the value from the API and logs a warning.ENV: The deployment configuration is authoritative. On start, every field that it defines overwrites the stored value, and you can’t change that field through the API. Fields that the file doesn’t define stay editable.DB: OpenMetadata keeps the stored values. The deployment configuration only fills fields that the stored configuration doesn’t have.
configSource block also has these options:
SECURITY_CONFIG_SOURCE_CONFIRM_PROVIDER_CHANGE: Defaultfalse. Set it totrueto let the first start inENVmode replace the stored identity provider with a different one from the file.CONFIG_SOURCE_WATCH_INTERVAL_SECONDS: Default10. How often each server checks the database for settings that another server, the command-line tool, or an administrator changed.
Managed by Environment Error
When a group is inENV mode and a request changes a field that the deployment configuration defines, OpenMetadata returns 409 with the error type SETTINGS_MANAGED_BY_ENVIRONMENT:
<paths> lists the changed fields. It reads it when the deployment configuration owns the whole setting.
Get the Source of Each Setting
GET /v1/system/settings/source returns the source of every setting. Only administrators can call it.
GET /v1/system/settings/source
Adopt the Deployment Configuration
POST /v1/system/settings/source/{configType}/adopt makes the deployment value win for fields where a stored value overrides it. Only administrators can call it.
It returns the updated setting source. In ENV mode it returns 409 with The deployment configuration already owns the setting.