Skip to content

Commit aab6973

Browse files
committed
add CAPI prerequisites section to cluster-autoscaler README
This change adds a section to the cluster-autoscaler CAPI provider README which details the required prerequisites for using the autoscaler. It is being added to help inform users about the restrictions that are currently in place with regards to using this provider.
1 parent 7005cc8 commit aab6973

File tree

1 file changed

+8
-0
lines changed
  • cluster-autoscaler/cloudprovider/clusterapi

1 file changed

+8
-0
lines changed

cluster-autoscaler/cloudprovider/clusterapi/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ cluster.
1010
The cluster-api provider requires Kubernetes v1.16 or greater to run the
1111
v1alpha3 version of the API.
1212

13+
## Cluster API Prerequisites
14+
15+
Please be aware that currently the cluster autoscaler only supports CAPI
16+
clusters that have joined their management and workload clusters into a single
17+
cluster. For more information about this please see the
18+
[Cluster API Concepts documentations](https://cluster-api.sigs.k8s.io/user/concepts.html)
19+
and the [`clusterctl move` command documentaion](https://cluster-api.sigs.k8s.io/user/concepts.html).
20+
1321
## Starting the Autoscaler
1422

1523
To enable the Cluster API provider, you must first specify it in the command

0 commit comments

Comments
 (0)