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 all values/defaults in func.yaml #1841

Closed
Tracked by #2026
mvinkler opened this issue Jul 3, 2023 · 5 comments
Closed
Tracked by #2026

Document all values/defaults in func.yaml #1841

mvinkler opened this issue Jul 3, 2023 · 5 comments
Labels
kind/documentation lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@mvinkler
Copy link
Contributor

mvinkler commented Jul 3, 2023

There should be a section for each runtime which documents all possible configuration options and used defaults.

Without this, user cannot easily find out what defaults are applied to their application (for example definition of health checks for a Quarkus runtime).

@mvinkler
Copy link
Contributor Author

mvinkler commented Jul 3, 2023

/kind documentation

@lance
Copy link
Member

lance commented Jul 3, 2023

We do currently have a document for func.yaml but it clearly is missing some references such as the health endpoints. https://github.com/knative/func/blob/main/docs/reference/func_yaml.md

@lkingland
Copy link
Member

lkingland commented Jul 3, 2023

Sometimes this conundrum is solved by writing a fully-populated, but commented-out config file to disk, which has all (commented) values set to their defaults at time of installation.

We can not fully replicate the workflow due to the choice of yaml as our config file format, but, we could potentially get most of the benefit by prepending this fully-populated config as a generated header to func.yaml on save.

The header config comment block would not inhibit the parsing of the config, and we would be free to add as much exposition as is necessary for each setting, while not falling into the pitfalls of a pre-populated config.

This also has an interesting potential benefit of allowing us to re-generate this docs header as the system is updated so it stays current.

@lkingland
Copy link
Member

We can also write the func.yaml as a Go template, as is outlined in #1853

@lkingland lkingland mentioned this issue Oct 17, 2023
15 tasks
Copy link
Contributor

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
Status: ✅ Done
Development

No branches or pull requests

3 participants