clusterctl

README

clusterctl

clusterctl is the SIG-cluster-lifecycle sponsored tool that implements the Cluster API.

Read the experience doc here.

Getting Started

Prerequisites

1. Install minikube
2. Install a driver. For Linux, we recommend kvm. For MacOS, we recommend VirtualBox.
3. Build the clusterctl tool

$ git clone https://github.com/kubernetes-sigs/cluster-api.git $GOPATH/src/sig.k8s.io/cluster-api
$ cd $GOPATH/src/sigs.k8s.io/cluster-api/clusterctl/
$ go build

Limitations

TBD

Creating a cluster

1. Create a cluster.yaml, machines.yaml and provider-components.yaml files configured for your cluster. See the provider specific templates and generation tools at $GOPATH/src/sigs.k8s.io/cluster-api/clusterctl/examples/<provider>.
2. Create a cluster

clusterctl create cluster --provider [google/vsphere] -c cluster.yaml -m machines.yaml -p provider-components.yaml

Additional advanced flags can be found via help

clusterctl create cluster --help

Interacting with your cluster

Once you have created a cluster, you can interact with the cluster and machine resources using kubectl:

$ kubectl --kubeconfig kubeconfig get clusters
$ kubectl --kubeconfig kubeconfig get machines
$ kubectl --kubeconfig kubeconfig get machines -o yaml

Scaling your cluster

NOT YET SUPPORTED!

Upgrading your cluster

NOT YET SUPPORTED!

Node repair

NOT YET SUPPORTED!

Deleting a cluster

NOT YET SUPPORTED!

clusterctl does not yet support deletion, please see provider specific deletion guides:

• google

Contributing

If you are interested in adding to this project, see the contributing guide for information on how you can get involved.