Skip to content

docs(autoscaler): add details about flags #7993

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

pierreozoux
Copy link

It is currently slightly confusing if you skim through the documentation.

For instance, see the discussion here:
#7974

I hope that by adding these 2 Important section the reader would be warned about the key difference, and need for these 2 options.

What type of PR is this?

/kind documentation

It is currently slightly confusing if you skim through the documentation.

For instance, see the discussion here:
kubernetes#7974

I hope that by adding these 2 Important section the reader would be warned about the key difference, and need for these 2 options.
@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. area/cluster-autoscaler labels Mar 28, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: pierreozoux
Once this PR has been reviewed and has the lgtm label, please assign elmiko for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the area/provider/cluster-api Issues or PRs related to Cluster API provider label Mar 28, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @pierreozoux. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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 the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 28, 2025
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 28, 2025
@pierreozoux
Copy link
Author

pierreozoux commented Mar 28, 2025

@elmiko maybe this way?
(I'm no professional doc writer, but I hope it helps :) )

@elmiko
Copy link
Contributor

elmiko commented Apr 15, 2025

hey, apologies, i was out for kubecon and then pto. i need to give this some thought, will add it to my queue for this week.

Copy link
Contributor

@elmiko elmiko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think it's difficult to summarize how these flags are used because their use can change slightly depending on how the topology is configured.

@pierreozoux
Copy link
Author

Thanks for your help, I did implement your recommendations.

@@ -79,6 +79,12 @@ in the staging namespace, belonging to the purple cluster, with the label owner=

## Connecting cluster-autoscaler to Cluster API management and workload Clusters

> [!IMPORTANT]
> `--cloud-config` is the flag for specifying a mount volume path to the kubernetes configuration (ie KUBECONFIG) to the cluster-autoscaler for communicating with the cluster-api management cluster for the purpose of scaling machines.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove "to the cluster-autoscaler" for both of these, as that relationship is already implied, I think (and it stutters following the "to the kubernetes configuration" part of the sentence).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i was trying to be as specific as possible given the context, perhaps "for the cluster-autoscaler" ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ya I think that's better

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cluster-autoscaler area/provider/cluster-api Issues or PRs related to Cluster API provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants