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

Dynamically insert default configuration parameters #353

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

voetberg
Copy link
Contributor

@voetberg voetberg commented Aug 2, 2024

Addressing #325

Creates a json file from opt/rucio/rucio.cfg which is read by configuration_parameters.mdx for each section/option. Includes the parameter if the field is in the config, or else just puts in "No default."

@voetberg voetberg requested a review from rdimaio August 2, 2024 15:47
Copy link
Contributor

@rdimaio rdimaio left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for doing this. I wonder if we could go a step further and generate the doc page so that the config sections and parameter names are also automatically pulled from the example cfg files, to avoid having to manually maintain this at all

- **idpsecrets**: Path of the idpsecrets JSON. Example:
`/opt/rucio/etc/idpsecrets.json`. <Defaults section="oidc" option="idpsecrets"> </Defaults>
#### **permission**
- **policy**: _(Optional)_ Permission policy. Values: `{atlas, belleii, cms,
Copy link
Contributor

Choose a reason for hiding this comment

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

These values atlas, belleii, cms... are specific to those experiments, so I don't think they should be included here

@voetberg
Copy link
Contributor Author

voetberg commented Aug 5, 2024

Looks good, thanks for doing this. I wonder if we could go a step further and generate the doc page so that the config sections and parameter names are also automatically pulled from the example cfg files, to avoid having to manually maintain this at all

I like that idea a lot, I don't think it would be too hard to swing. I am worried that it would shift the work of documentation to the config file instead of the md file (not all the parameters are in the config file to begin with - view this log).

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