Overview of clusterctl

The clusterctl CLI tool handles the lifecycle of a Cluster API management cluster.

The clusterctl command line interface is specifically designed for providing a simple “day 1 experience” and a quick start with Cluster API. It automates fetching the YAML files defining provider components and installing them.

Additionally it encodes a set of best practices in managing providers, that helps the user in avoiding mis-configurations or in managing day 2 operations such as upgrades.

• use clusterctl init to install Cluster API providers

• use clusterctl upgrade to upgrade Cluster API providers

• use clusterctl delete to delete Cluster API providers

• use clusterctl generate cluster to spec out workload clusters

• use clusterctl generate yaml to process yaml

• use clusterctl get kubeconfig to get the kubeconfig of an existing workload cluster. using clusterctl’s internal yaml processor.

• use clusterctl move to migrate objects defining a workload clusters (e.g. Cluster, Machines) from a management cluster to another management cluster

• use clusterctl alpha rollout to rollout Cluster API resources such as MachineDeployments. Note that this is currently an alpha level feature.