All apps/clusterctl

clusterctl

clusterctl
Runs as clusterctl|macOS, Linux, Windows|cluster-api.sigs.k8s.io

Command form

ai-draft · 6 tasks · 23 fields

Install providers, generate and describe clusters, and move Cluster API objects with clusterctl. Upgrade, delete and other commands are left out.

Opens the form; the finished command lands at your prompt, unrun
otty gui clusterctl

clusterctl init

Install providers
Install providersExample values, fixed in this page — nothing here reaches a terminal
Basic
Infrastructure provider*
string
Target namespace
string
TasksEach one presets the form for one job
Init with infrastructure
infrastructuretarget_namespace
ParametersOnly these flags are editable in the form
Infrastructure provider
e.g. aws or aws:v0.4.1.
string
--infrastructure
Core provider
string
--core
Bootstrap provider
string
--bootstrap
Control plane provider
string
--control-plane
Target namespace
string
--target-namespace

clusterctl generate cluster

Generate a cluster manifest
Generate a cluster manifestExample values, fixed in this page — nothing here reaches a terminal
Basic
Cluster name*
string
Kubernetes version
string
Control plane machines
integer
Worker machines
integer
Infrastructure provider
string
Advanced
Template flavor
string
TasksEach one presets the form for one job
Generate manifest
namekubernetes_versioncontrol_plane_countworker_countinfrastructureflavor
List variables
namelist_variablesinfrastructureflavor
ParametersOnly these flags are editable in the form
Cluster name
string · positional 0
Kubernetes version
string
--kubernetes-version
Control plane machines
integer
--control-plane-machine-count
Worker machines
integer
--worker-machine-count
Infrastructure provider
string
--infrastructure
Template flavor
string
--flavor
Template source
URL or local file path of a cluster template.
string
--from
Target namespace
string
--target-namespace
List template variables
boolean
--list-variables

clusterctl describe cluster

Describe a cluster
Describe a clusterExample values, fixed in this page — nothing here reaches a terminal
Basic
Cluster name*
string
Show infrastructure and bootstrap objects
--echo
Show all conditions for kinds
string
TasksEach one presets the form for one job
Describe
nameechoshow_conditions
ParametersOnly these flags are editable in the form
Cluster name
string · positional 0
Group identical machines
boolean
--grouping
Show infrastructure and bootstrap objects
boolean
--echo
Show all conditions for kinds
Comma separated kind or kind/name list.
string
--show-conditions

clusterctl move

Move Cluster API objects
Move Cluster API objectsExample values, fixed in this page — nothing here reaches a terminal
Basic
Target kubeconfig*
file
Namespace
string
Dry run set by task
--dry-run
TasksEach one presets the form for one job
Preview a move
to_kubeconfignamespacedry_run
Move to another cluster
to_kubeconfignamespace
ParametersOnly these flags are editable in the form
Target kubeconfig
path
--to-kubeconfig
Namespace
string
--namespace
Export to directory
path
--to-directory
Import from directory
path
--from-directory
Dry run
boolean
--dry-run
SourcesEvery flag above is checked against these
help
clusterctl init --infrastructure aws --core flag, the --bootstrap flag or the --control-plane flags specify the target namespace by using the --target-namespace flag
help2026-10-27

cluster-api.sigs.k8s.io

help
clusterctl generate cluster my-cluster --kubernetes-version v1.28.0 --control-plane-machine-count=3 --worker-machine-count=3 > my-cluster.yaml --infrastructure aws:v0.4.1 --flavor high-availability --from https://foo.bar/my-template.yaml --target-namespace clusterctl generate cluster --list-variables flag
help2026-10-27

cluster-api.sigs.k8s.io

help
clusterctl describe cluster capi-quickstart By using --grouping=false, the user can force the visualization to show all the machines By using the --echo flag --show-conditions KubeadmControlPlane
help2026-10-27

cluster-api.sigs.k8s.io

help
clusterctl move --to-kubeconfig="path-to-target-kubeconfig.yaml" use the --namespace flag clusterctl move --to-directory and clusterctl move --from-directory With --dry-run option you can dry-run the move action
help2026-10-27

cluster-api.sigs.k8s.io

Before it fills your prompt, Otty checks the installed clusterctl against its version. A form that does not match your version is not offered.