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

Support usage of SMURF_CONFIG_DIR instead of OCS_CONFIG_DIR #449

Merged
merged 3 commits into from
Jan 3, 2025

Conversation

jlashner
Copy link
Collaborator

This PR adds support for an environment variable $SMURF_CONFIG_DIR which will replace $OCS_CONFIG_DIR if it is specified.

The OCS_CONFIG_DIR technically needs to be the directory where the OCS default.yaml file exists, which for most lab-setups is the same as the directory where the sys_config.yml and smurf-config files live. However for deployed servers these are different. We've been getting around by always manually specifying the ocs site-config file on deployment servers, but this will no longer be possible when the smurf-server environment is managed more by site-computing.

Moving forward, we will want to point to the smurf-configuration directory using a separate environment variable, $SMURF_CONFIG_DIR, which defaults to OCS_CONFIG_DIR if it is not set.

Copy link
Member

@BrianJKoopman BrianJKoopman left a comment

Choose a reason for hiding this comment

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

This looks good to me, but doing a git grep 'OCS_CONFIG_DIR' I noticed some other spots that probably could use updating to use SMURF_CONFIG_DIR:

  • docs/configs.rst
  • docs/scripting_guide.rst
  • tests/input/sys_config.yml

@jlashner jlashner force-pushed the smurf-config-dir-env branch from b915071 to fa2097f Compare December 12, 2024 16:36
@jlashner
Copy link
Collaborator Author

Thanks Brian, I clarified the docs with regards to the configuration directory and changed wording to be more general.

@jlashner
Copy link
Collaborator Author

jlashner commented Jan 3, 2025

This has been tested with the new deployment configuration on smurf-srv20-satp1.

@jlashner jlashner merged commit 85dda5f into master Jan 3, 2025
1 check passed
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.

2 participants