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

Update flags for vpa components automatically #7589

Closed
voelzmo opened this issue Dec 11, 2024 · 3 comments · Fixed by #7599
Closed

Update flags for vpa components automatically #7589

voelzmo opened this issue Dec 11, 2024 · 3 comments · Fixed by #7599
Assignees
Labels
area/vertical-pod-autoscaler kind/feature Categorizes issue or PR as related to a new feature.

Comments

@voelzmo
Copy link
Contributor

voelzmo commented Dec 11, 2024

Which component are you using?:
/area vertical-pod-autoscaler

Is your feature request designed to solve a problem? If so describe the problem this feature should solve.:
Keeping the flag documentation at https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/docs/faq.md#what-are-the-parameters-to-vpa-recommender up-to-date is a manual effort, which is cumbersome and error-prone.

Describe the solution you'd like.:
We should auto-generate the flag docs similar to #7014

Options are: running it automatically in our CI or putting it into some make generate command and force PR authors to run this before they submit with a pre-check.

@voelzmo voelzmo added the kind/feature Categorizes issue or PR as related to a new feature. label Dec 11, 2024
@adrianmoisey
Copy link
Member

+1

I also want to generate the API documentations automatically, which is something I'm busy working on

@omerap12
Copy link
Member

/assign

@omerap12
Copy link
Member

Perhaps I'm mistaken, but it seems the documentation is not up to date. Having this script would be useful for keeping them current.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/vertical-pod-autoscaler kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants