docs: mention env var support in apisix.yaml
#10727
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Mention env var support in
apisix.yaml
and add a caution note for exporting vars.See the below issues for more background info:
Closes #10509
Closes #10530
The info is also mentioned in the Admin API doc but not easy to locate. Personally I only found out after looking for the PR that adds the feature.
From a user perspective, when I search for apisix config env var, this is the doc that comes up first.
Though it seems from the doc title that this doc wasn't originally for this content.
There has been other user that recently mentioned the info could not be located:
https://the-asf.slack.com/archives/CUC5MN17A/p1703518877003939
Checklist