feat: allow specifying a path from which secrets are read - #227
Open
atticus-sullivan wants to merge 3 commits into
Open
feat: allow specifying a path from which secrets are read#227atticus-sullivan wants to merge 3 commits into
atticus-sullivan wants to merge 3 commits into
Conversation
enables to use docker(-compose) secrets: https://docs.docker.com/compose/how-tos/use-secrets/ see how this implements the convention of suffixing the env-vars with `_FILE` mentioned on https://docs.docker.com/compose/how-tos/use-secrets/
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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.
The incentive behind this is the following: Docker(-compose) supports passing secrets into the container by specifying
secretskeys in thedocker-compose.yml(https://docs.docker.com/compose/how-tos/use-secrets/). Behind the scenes, this leads to a file being mounted (typically as/run/secrets/<secret_name>) into the container with the secret as content.Quite a lot of software (like mysql and postgres, see e.g. https://docs.docker.com/compose/how-tos/use-secrets/) nowadays thus supports suffixing configuration options (mostly environment variables) with
_FILEfor this purpose.One advantage of this approach is that the secret does not get easily leaked when dumping the environment variables (or inspecting them).
Things to discuss:
SQLALCHEMY_DATABASE_URLwhich was a must-have foralembicwhere now the url can also be read from the config-file). Is there a specific reason for not having an env-var option to setsecret_session_keyorsecret_jwt_key_file?.strip()really right? Are we sure enough people do not use spaces at the beginning/end of their secrets deliberately?the big question from my side would be where to place a helper like this? Would the location simply be
src/config.py?