You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our config parameters docs page starts out boldly with an example YAML config file, and we've observed users trying to copy-paste the example as a template for configuring their service.
Unfortunately, the example yaml is gobbledygook that doesn't doesn't compile, let alone work as a functional template...
At minimum, we should provide a config template that compiles. The best case would be to provide a minimal config example for each component -- it may be possible to provide one big config template that acts as a minimal working example for all components, but that might be more confusing than helpful. @aowen-uwmad, what do you think is ideal here? I'm inclined to think we create one minimal config per component.
The text was updated successfully, but these errors were encountered:
In discussion with @aowen-uwmad, and we think a minimal config per component is good, but we'd also like to link out to osg-htc.org where we can host an example for each service of "how we do things in production"
Theoretically the best config is the default values, so our minimal config would be the default values. Depending on how dynamic the default values are this might cause pain if we change the default values without updating this minimal config.
There are some defaults that can't be filled in for generic cases, e.g. if you're setting up an origin, you still need to define the origin's exports, capabilities, federation discovery url, etc. I think most of our services can be set up as bare bones in ~15-20 lines of config. My goal is that someone could copy-paste, fill in a few blanks, and then run the service without any crashes/errors.
Our config parameters docs page starts out boldly with an example YAML config file, and we've observed users trying to copy-paste the example as a template for configuring their service.
Unfortunately, the example yaml is gobbledygook that doesn't doesn't compile, let alone work as a functional template...
At minimum, we should provide a config template that compiles. The best case would be to provide a minimal config example for each component -- it may be possible to provide one big config template that acts as a minimal working example for all components, but that might be more confusing than helpful. @aowen-uwmad, what do you think is ideal here? I'm inclined to think we create one minimal config per component.
The text was updated successfully, but these errors were encountered: