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

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

Open
gjtempleton opened this issue Jun 26, 2024 · 6 comments
Open
Assignees
Labels
area/cluster-autoscaler good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@gjtempleton
Copy link
Member

gjtempleton commented Jun 26, 2024

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 gjtempleton added the kind/feature Categorizes issue or PR as related to a new feature. label Jun 26, 2024
@gjtempleton
Copy link
Member Author

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

@k8s-ci-robot
Copy link
Contributor

@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:

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

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. area/cluster-autoscaler help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Jun 26, 2024
@rainfd
Copy link

rainfd commented Jun 27, 2024

/assign

@rainfd
Copy link

rainfd commented Jun 27, 2024

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

@gjtempleton
Copy link
Member Author

@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
Copy link
Contributor

/triage accepted

@k8s-ci-robot k8s-ci-robot added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cluster-autoscaler good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

4 participants