Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs about using env vars for credentials with OmegaConfLoader #2256

Merged
merged 4 commits into from
Jan 25, 2023

Conversation

merelcht
Copy link
Member

@merelcht merelcht commented Jan 24, 2023

Description

Docs to follow up #2178

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes

@merelcht merelcht requested a review from yetudada as a code owner January 24, 2023 14:22
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
@merelcht merelcht force-pushed the docs/env-variables-for-credentials branch from 24a87fd to 7d8bd4d Compare January 24, 2023 14:23
@merelcht merelcht self-assigned this Jan 24, 2023
@merelcht merelcht requested review from stichbury and jmholzer and removed request for yetudada January 24, 2023 14:24
@merelcht merelcht linked an issue Jan 24, 2023 that may be closed by this pull request
@datajoely
Copy link
Contributor

Can you do non-credentials too? I'm sure people will want to override params and other conditional stuff?

@merelcht
Copy link
Member Author

Can you do non-credentials too? I'm sure people will want to override params and other conditional stuff?

No. In the interviews we did about config loaders the majority of the users that make use of environment variables in Kedro projects said they use them to store credentials. Environment variables shouldn't be used an abused all over the place, so if we decide to add more support for them we'd have to first find out what valid use cases apart from credentials exist.

Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thanks for the preview 🙏

merelcht and others added 2 commits January 25, 2023 11:27
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Copy link
Contributor

@jmholzer jmholzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like these docs, straightforward and clear ✅.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow users to pass credentials through environment variables
4 participants