-
Notifications
You must be signed in to change notification settings - Fork 13
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
Minor consolidation of Environment Variables #614
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I'll wait for other opinions before approving, though.
I agree with keeping defaults in a single point, and adding configuration if needed.
I think this is a great consolidation PR @njbrake ! Just added a minor comment on the Makefile. Also, what do you think about also having the |
@agpituk would it be ok if we push that change off into a future change? Tbh I'm not totally sure how the database setup works yet, and that env var shows up in enough places that I'm not yet confident that I won't accidentally break something when trying to change it 😆 . |
definitely! :) I'll open an issue so we don't forget. Thanks @njbrake |
What's changing
This pull request involves several changes to update environment configuration files and improve the setup for local development and testing. The key changes include renaming the environment template file, updating references across the codebase, and modifying environment variable defaults.
Environment Configuration Updates:
.env.example
renamed to.env.template
and updated with additional comments and placeholders for various configuration sections. [1] [2]Makefile Adjustments:
Makefile
to reference the new.env.template
file instead of the old.env.example
file.Makefile
.Documentation Update:
docs/source/user-guides/inference.md
from.env.example
to.env.template
.Backend Settings Update:
lumigator/python/mzai/backend/backend/settings.py
to remove default values forS3_BUCKET
,RAY_HEAD_NODE_HOST
, andRAY_DASHBOARD_PORT
, indicating that these should be specified in the.env
file.How to test it
Steps to test the changes:
make local-up
, check to see if .env file variables are correctly loaded.Additional notes for reviewers
The idea of this PR is that now the environment variable file is only used for overrides, not for regular settings.
I already...
/docs
)