Is it possible to read environment variables from yaml configuration files?

[abbluiz]

I want to use different configuration depending on my environment on some YAML configuration files, specially in conf/apisix.yaml in stand-alone mode. Is it possible to read from environment variable like ${VAR} inside YAML file?

[tzssangglass]

refer to:https://github.com/apache/apisix/blob/master/docs/en/latest/profile.md

[abbluiz]

I saw this, however it is not flexible enough for me. I would like do store OAuth 2.0 endpoints and client secret in environment variables and use them inside the files like ${OAUTH_INTROSPECTION_ENDPOINT}. This is because I commit my route config whilst using stand alone mode.

[tzssangglass]

try use ${{VAR}} in config.yaml, refer to

apisix/conf/config.yaml

Line 24 in a413014

# To configure via environment variables, you can use `${{VAR}}` syntax. For instance:

[abbluiz]

Yes, but what about other configuration files, like apisix.yaml when using stand alone mode? It seems that this syntax does not work for it.

[tzssangglass]

sounds like a good feature.

[tzssangglass]

@spacewander @tokers @membphis what's your options?

[abbluiz]

Yes, it would be great to be natively supported. To anyone interested, for now I am creating a temporary docker container that parses the yaml file and replaces with my environment variables using a Python script.

[tokers]

I think so, it's my understanding that secrets are not suitable to be written in the configuration directly, env should be supported.

[spacewander]

The variable resolve is done in

apisix/apisix/cli/file.lua

Line 218 in 8ac00e0

local ok, err = resolve_conf_var(user_conf)

We can do the same thing with

apisix/apisix/core/config_yaml.lua

Line 60 in 8ac00e0

local function read_apisix_yaml(premature, pre_mtime)

after refactor.

PR is welcome!

[tzssangglass]

I've turned this discussion into an issue. refer to:#5243 see:#5244