Cluster Autoscaler: Auto-generate the supported flags table in docs

gjtempleton commented 3 months ago

Which component are you using?: Cluster autoscale

Is your feature request designed to solve a problem? If so describe the problem this feature should solve.:

Auto-generate the very long table of supported flags for the CA in our FAQ to reduce the chance of either missing new flags, or failing to remove/update flags which are no longer supported or which have changed their defaults.

Describe the solution you'd like.: Likely a new hack script with a PR time run to check for drift.

Describe any alternative solutions you've considered.:

Additional context.: N/A

gjtempleton commented 3 months ago

/area cluster-autoscaler /good-first-issue /help-wanted

k8s-ci-robot commented 3 months ago

@gjtempleton: This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

Why are we solving this issue?
To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
Does this issue have zero to low barrier of entry?
How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-good-first-issue command.

In response to [this](https://github.com/kubernetes/autoscaler/issues/6981): >/area cluster-autoscaler >/good-first-issue >/help-wanted Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.

rainfd commented 3 months ago

/assign

rainfd commented 3 months ago

@gjtempleton Update directly on the original FAQ? No need to update the helm chart related fields?

gjtempleton commented 3 months ago

@rainfd No need to update the Helm chart, we already have linting on the Readme for the chart, and we just link out to the CA's Readme for the extraArgs values option that corresponds to the runtime args to the CA.

Shubham82 commented 2 months ago

/triage accepted

kubernetes / autoscaler

Cluster Autoscaler: Auto-generate the supported flags table in docs #6981

Guidelines