feat(pbs): load relay headers from a secret file or env var - #498
Open
JasonVranek wants to merge 1 commit into
Open
feat(pbs): load relay headers from a secret file or env var#498JasonVranek wants to merge 1 commit into
JasonVranek wants to merge 1 commit into
Conversation
This file contains hidden or 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
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.
Summary
A relay's custom headers, which is how a relay
X-Api-keyis supplied, can now come from a secret file or an environment variable instead of the config file:The value is read when the relay client is built, at startup and on every config reload, so a rotated secret is picked up by a reload.
Header values are marked sensitive so they never appear in debug output, and a literal never appears in the config's
Debug. A header loaded from a secret logs its source and a 4-byte fingerprint of the value, never the value, so a rotation is visible across reloads.commit-boost initmounts everyfilepath read-only into the PBS container at the same path and passes everyenvvariable through from the compose environment, for default and mux relays alike. A relative or missing file failsinitrather than producing a compose file docker fills with a root-owned directory.