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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 21, 2025
Merged

docs(autoscaler): add details about flags #7993

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a954bc
docs(autoscaler): add details about flags
pierreozoux Mar 28, 2025
6eebb82
Update cluster-autoscaler/cloudprovider/clusterapi/README.md
pierreozoux Apr 17, 2025
e51dcfb
Update cluster-autoscaler/cloudprovider/clusterapi/README.md
pierreozoux Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions cluster-autoscaler/cloudprovider/clusterapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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


> [!IMPORTANT]
> ``--kubeconfig` 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 workload cluster for the purpose of watching Nodes and Pods. This flag can be affected by the desired topology for deploying the cluster-autoscaler, please see the diagrams below for more information.

You will also need to provide the path to the kubeconfig(s) for the management
and workload cluster you wish cluster-autoscaler to run against. To specify the
kubeconfig path for the workload cluster to monitor, use the `--kubeconfig`
Expand Down