Make plugin-specific env take precedence over sys env #25128
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tomhjp
force-pushed
the
vault-23513/plugin-specific-env-override-sys
branch
from
02c7ee3
to
f480a7a
Compare
github-actions
bot
added
the
hashicorp-contributed-pr
|
Build Results: |
|
CI Results: |
austingebauer
approved these changes
Jan 30, 2024
| // go-plugin so always set SkipHostEnv and replicate the legacy behavior | ||
| // ourselves if user opts in. | ||
| if legacy, _ := strconv.ParseBool(os.Getenv(PluginUseLegacyEnvLayering)); legacy { | ||
| // Env vars are layered as follows, with later entries overriding |
| @@ -69,6 +70,115 @@ func testPluginCatalog(t *testing.T) *PluginCatalog { | |||
| return pluginCatalog | |||
| } | |||
|
|
|||
| type warningCountLogger struct { | |||
There was a problem hiding this comment.
Neat pattern to test on the logs!
|
Thanks! |
Monkeychip
pushed a commit
that referenced
this pull request
Feb 5, 2024
* Make plugin-specific env take precedence over sys env * Expand the existing plugin env integration test --------- Co-authored-by: Austin Gebauer <34121980+austingebauer@users.noreply.github.com>
Monkeychip
pushed a commit
that referenced
this pull request
Feb 7, 2024
* Make plugin-specific env take precedence over sys env * Expand the existing plugin env integration test --------- Co-authored-by: Austin Gebauer <34121980+austingebauer@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Unless
SkipHostEnvis set, go-plugin layersos.Environ()over the top of any environment provided in theClientConfig's command: https://github.com/hashicorp/go-plugin/blob/586d14f3dcef1eb42bfb7da4c7af102ec6638668/client.go#L657While it's too big of a breaking change to switch that behaviour in go-plugin, for Vault it seems pretty obvious that users would expect the env they specify for plugins to take precedence over the system env. For example, if most of Vault should use one proxy via HTTP_PROXY, but one plugin needs to use a different proxy, it should be possible to override the base setting when registering the plugin.
I've added a flag to opt out of the behaviour change though, and also implemented log warnings to help any users concerned about unexpected changes in behaviour.