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

Document new yaml based configs #496

Open
josibake opened this issue Aug 26, 2024 · 1 comment
Open

Document new yaml based configs #496

josibake opened this issue Aug 26, 2024 · 1 comment

Comments

@josibake
Copy link
Collaborator

Now that we are using helm, configuration is done using the network.yaml/node-defaults.yaml files. These are mostly thin wrappers around a helm values.yaml file, but it would good to have some clear documentation and examples of how to use the files.

Could also be addressed in a separate issue, but it might be worth naming the files config.yaml no matter where they are used? The user knows what they are configuring based on the directory name (currently we have networks/ and namespaces/). This would make tab complete a bit easier. There's also some UX around whether or not we need a defaults file or if we can omit it and only apply default overrides if the users provides a defaults file. This means all defaults would then be in the values.yaml file.

cc @m3dwards

@willcl-ark
Copy link
Contributor

Does https://github.com/willcl-ark/warnet/blob/value-prop/docs/config.md from #513 help here?

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

No branches or pull requests

2 participants