Home for the Cluster Management API work, a subproject of sig-cluster-lifecycle
Clone or download
Permalink
Failed to load latest commit information.
.github Update links in the pull request template. (#473) Aug 14, 2018
clusterctl clusterctl: match kubeconfig by path instead of content (#500) Sep 18, 2018
cmd Add goflag parsing to pflags (#454) Jul 26, 2018
docs Update documentation now that the provider specific code has been (#445) Jul 25, 2018
hack Verify boilerplate (#359) Jun 22, 2018
pkg run make depend (#507) Sep 20, 2018
sample Remove machine role from the MachineSpec in the Cluster API (#405) Jul 24, 2018
scripts Add "all" target to Makefile (#373) Jun 21, 2018
tools Update bazel tasks & regenerate BUILD files (#451) Jul 25, 2018
vendor run make depend (#507) Sep 20, 2018
.gitignore gitignore bazel symlinks (#452) Jul 25, 2018
BUILD.bazel Update bazel tasks & regenerate BUILD files (#451) Jul 25, 2018
CONTRIBUTING.md Update documentation now that the provider specific code has been (#445) Jul 25, 2018
Gopkg.lock run make depend (#507) Sep 20, 2018
Gopkg.toml Openapi gen (#464) Jul 30, 2018
LICENSE Initial commit Apr 15, 2018
Makefile Refer to gen* binaries using explicit path names in Makefile (#508) Sep 20, 2018
OWNERS Add "reviewers" list to OWNERS for auto-assign (#368) Jun 21, 2018
OWNERS_ALIASES Add mkjelland to the cluster-api OWNERs file (#337) Jun 14, 2018
README.md docs: add link to digitalocean provider (#506) Sep 19, 2018
SECURITY_CONTACTS Add SECURITY_CONTACTS file. The list of contacts is equal to the 'sig… May 24, 2018
WORKSPACE Update bazel tasks & regenerate BUILD files (#451) Jul 25, 2018
architecture.png Moving everything up a directory Apr 16, 2018
boilerplate.go.txt Moving everything up a directory Apr 16, 2018
code-of-conduct.md Add code-of-conduct.md Dec 20, 2017

README.md

Cluster API

What is the Cluster API?

The Cluster API is a Kubernetes project to bring declarative, Kubernetes-style APIs to cluster creation, configuration, and management. It provides optional, additive functionality on top of core Kubernetes.

Note that Cluster API effort is still in the prototype stage while we get feedback on the API types themselves. All of the code here is to experiment with the API and demo its abilities, in order to drive more technical feedback to the API design. Because of this, all of the prototype code is rapidly changing.

Cluster API Architecture

To learn more, see the Cluster API KEP.

Get involved!

  • Join the sig-cluster-lifecycle Google Group for access to documents and calendars.

  • Join our Cluster API working group sessions

  • Provider implementer office hours

    • Weekly on Mondays @ 09:30 PT and Tuesdays @ 12:00 PT on Zoom
    • Previous meetings: [ notes ]
  • Chat with us on Slack: #cluster-api

Provider Implementations

The code in this repository is independent of any specific deployment environment. Provider specific code is being developed in separate repositories, some of which are also sponsored by SIG-cluster-lifecycle:

Getting Started

Prerequisites

  • kubectl is required, see here.
  • clusterctl is a SIG-cluster-lifecycle sponsored tool to manage Cluster API clusters. See here

How to use the API

To see how to build tooling on top of the Cluster API, please check out a few examples below:

  • upgrader: a cluster upgrade tool.
  • repair: detect problematic nodes and fix them.